OpenAPIに触れたので調べてみました。
OpenAPIとは?
OpenAPIと呼ばれているのは、
厳密にはOpen API Specification (OAS)のこと。
OASとは、RESTfulAPIを定義するフォーマットのこと。
APIを定義って具体的にどういうこと?
APIのHTTPメソッドやパス、パラメータや、レスポンスの型などの情報を、フォーマットに則って定義したりできます。
英語ですが、こんな感じで書いてありました。
APIを定義して何ができる?何が嬉しい?
OpenAPIの関連ツールを使うことで、
API定義をもとにコード生成したり、ドキュメント生成したりできるので、開発が楽になったり、メンテが楽になったりします。
スキーマファーストや、スキーマ駆動開発というワードで調べると、
いろいろメリットや恩恵などが出てきます。
OpenAPIどうやって使うの?
使うツールなどによって、いろいろなことができるので、
一旦、OASの書き方について、以下の記事だけ紹介します。
Open APIの関連ツール
Open APIに関連するツールには、以下のようなものがあるみたいです。
また、以下のような便利ライブラリがあります。