OpenAPIとSwaggerについて

概要

• OpenAPIとSwaggerについて調べたのでまとめる。

OpenAPIとは？

• yaml・JSONの記載フォーマットのことだよ。
• REST APIの仕様書を記載するフォーマットだよ。

OpenAPI Specification

• OpenAPIを記述するための書式ルールのことだよ。
  • 「Markdownだったら#でタイトルにできるよね」とかそういう感じの書き方のことだと思う。
• 公式ドキュメント達
  • https://swagger.io/specification/
  • https://spec.openapis.org/oas/v3.0.3
  • https://github.com/OAI/OpenApi-Specification/blob/main/versions/3.0.3.md

Swagger

• OpenAPIを作成・表示・利用するツール群のことだよ。
• そのツール群の中には下記が含まれるよ。
  • Swagger Editor
    • OpenAPIを記述・編集するためのエディターだよ。
  • Swagger Codegen
    • Swagger Editorで記述・編集されたOpenAPIを読み取ってスタブやクライアント側のコードを生成してくれるよ。
  • Swagger UI
    • OpenAPIを読み取って仕様書として表示してくれるよ。

簡単な歴史

1. 2010年 Swaggerの開発スタート
   • OpenAPIはSwaggerフレームワークの一部でSwagger Specificationって名前だったよ。
2. 2015年 OpenAPI Initiativeという組織に管理移管
3. 2016年 Swagger SpecificationからOpenAPI Specificationに名称変更

つぶやき

• 「OpenAPIで仕様書作成しておいて」という指示があったら「APIの詳細情報をyamlファイルにOpenAPI Specificationの書式ルールで記載しておいて」って解釈すればいいのかな・・・？