はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか? Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス
![スキーマファースト開発のためのOpenAPI(Swagger)設計規約 | フューチャー技術ブログ](https://cdn-ak-scissors.b.st-hatena.com/image/square/610a58abc6fc694ddbceaee45c483ce4f23169f5/height=288;version=1;width=512/https%3A%2F%2Ffuture-architect.github.io%2Fimages%2F20200409%2F1.png)