OpenAPI Specificationの紹介

TODO: OpenAPIについてはさらに深堀りしたい

参考: https://www.alpha.co.jp/blog/202208_02/

  • OpenAPI Specification(OAS)
    • 一般にOpenAPIと呼ばれ、REST APIの記述フォーマット(または記述)のことを指す
    • Webアプリケーション同士の安全な通信のために、どのような項目・形式で仕様を記載すべきか定義したフォーマットのこと
    • Excelなどで管理していたAPI仕様書をOpenAPIを用いて作成することで、フォーマットが統一されて管理しやすくなる
  • OpenAPIとSwaggerの関係
    • SwaggerとはOpenAPI記述のフォローやOpenAPIを利用して様々な働きをするオープンソースツールを指す
    • 仕様書の自動生成なども可能