OpenAPI Specification で API スキーマを定義する - WHITEPLUS TechBlog

こんにちは！コアシステム開発Gでテックリードをやっている古賀です。 APIを改修しようとすると、「どのようなリクエストを送るべきか？」「レスポンスはどのような形式か？」といった疑問に直面することは少なくありません。 コードを読まなければ分からなかったり、ドキュメントがあるものの埋もれていたりすると、そのたびに調査が必要になり生産性を下げてしまいます。 これを防ぐには、API仕様を事前に定義し、誰でも簡単に参照できるようにしておくことが有効です。 APIスキーマを定義する手段としては、gRPCのProtocol Buffersや、GraphQLのスキーマ定義言語など、目的に応じていくつかの方法が存在します。 その中でも、HTTPベースのRESTful APIにおけるスキーマ定義ツールである OpenAPI Specification（(以下 OpenAPIと表記）を紹介します。 OpenAP