OpenAPI
#OpenAPI #Swagger
概要
OpenAPI Specification
OpenAPI 仕様は、OpenAPI Initiative 内におけるコミュニティ駆動のオープン仕様であり、REST API のインタフェース記述を定義する。
GitHub リポジトリに仕様が存在する。
https://github.com/OAI/OpenAPI-Specification
OpenAPI Initiative
REST API の仕様記述の標準化を推し進める団体。Linux Foundation の元で、ベンダー中立な仕様記述形式の決定をサポートして行くことが目的となっている。
https://www.openapis.org
サポートツール
クライアントコード自動生成
openapi-generator
swagger-codegen
その他参考
https://qiita.com/Horie1024/items/ccfa0ff50c0b4f17b932
https://qiita.com/susieyy/items/862057346d47474f588d
openapi-generator vs swagger-codegen
前者は後者の v2.4 をフォークしたプロジェクト。
OpenAPI Specification 3 対応が迫られる中、swagger-codegen の対応はスポンサー企業の SmartBear 社のエンジニアによって主導されていた。が、その変更のされ方に疑問や不安を持ったコントリビュータが何名かおり、最終的に openapi-generator という別プロジェクトにフォークされ、ほとんどのコントリビュータもそちらに移っている、という状況のようだ。
https://ackintosh.github.io/blog/2018/05/12/openapi-generator/
https://www.publickey1.jp/blog/18/rest_apiapiopenapi_generatorswagger_generator.html