• OpenAPIとは
• 記述
• VSCodeでの使用方法
• Swagger Editerでの使用方法
• モックサーバの起動
• HTTPクライアントの生成
• OpenAPI-Specification Sample
• OpenAPI PetStore 図解

OpenAPIとは

OpenAPIはRestAPIの仕様書記述方法

• https://www.openapis.org/
• https://github.com/OAI/OpenAPI-Specification

Swaggerとは、OpenAPIを利用するためのツール群。

記述

• OpenAPI Specification(記述ルール)
• OpenAPI (Swagger) まとめ

VSCodeでの使用方法

Swagger ViewerExtensionを使用する。 openapiのyamlを開いてalt+shift+pでswagger UIのプレビュー可能。

Swagger Editerでの使用方法

• https://editor.swagger.io/
• ローカル起動方法

モックサーバの起動

Generate Server から各フレームワークでモックサーバコードを生成できる。

レスポンスはExampleに従う。

HTTPクライアントの生成

Generate Clientから各言語でHTTPクライアントコードを生成できる。

OpenAPI-Specification Sample

• https://github.com/OAI/OpenAPI-Specification/tree/main/examples

OpenAPI PetStore 図解