公式

https://www.openapis.org/

openapiのメリット

https://oai.github.io/Documentation/start-here.html#advantages-of-using-openapi

• ValidateとLintの対応
  • 記述ファイル（yamlが多い）が構文的に正しいかどうか、ガイドラインに準拠してるかどうかをチェックする
• dataの整合性
  • デプロイ時にチェックする
• documentの生成
  • 記述ファイルに基づいてドキュメントを生成する

openapi周りのライブラリ

Swagger-UI

仕様を実装するためのツール

OpenAPI generator

openapi generatorでClient情報(type.d.ts)を吐き出す

• open-api-generatorをinstallする

yarn add -D @openapitools/openapi-generator-cli

• clientを生成するscriptをpackage.jsonに追記する

参考

https://gift-tech.co.jp/articles/openapi-generator-typescript/

https://zenn.dev/katzumi/articles/api-scenario-testing-with-runn
runn + openapiのテスト戦略、あとでまとめる

https://qiita.com/teinen_qiita/items/e440ca7b1b52ec918f1b
超入門から入ってみる

https://speakerdeck.com/komtaki/openapide-le-nishi-merusukimaqu-dong-kai-fa-shi-jian-lun-php-conference-2022
phpconのときにあったOpenAPIのスキーマ駆動開発実践論

スライド5枚目にある

• 厳密な定義でなく、HTTP APIを記載した感じ
  • URL、メソッド、リクエスト、レスポンスなど

スライド10枚目によるとopenapiはv3.0がおすすめ