はてなブックマーク

OpenAPI でドキュメントを書くメリット OpenAPI でドキュメントを書くメリットは、大きく分けて二つの観点があると思います 短期的な開発リードタイム短縮 FE 開発 OpenAPI から API モックを作成して、API の実装を待つことなく実装ができる 例: Prism OpenAPI から API Client と I/F・Entity の型定義を自動生成することで、その実装の工数を省略+型安全な開発をすることができる 例: openapi-generator/typescript-axios BE開発 OpenAPIからController(一部)、バリデーションロジック、Request・Responseの型定義を生成できる 個人的にNest.js用のgeneratorが開発されていて楽しみです。 自動生成に対応している言語/フレームワーク一覧 - ada-server -