Zenn
Open4

【API設計】OpenAPI・Swaggerについて

API
OpenAPI
api設計
swgger
まさぴょんまさぴょん

OpenAPI・Swaggerについて

Swaggerとは？

  1. SwaggerはREST APIを記述するためのインターフェース言語
  2. JSNOやYAMLで記載する
  3. サードパーティ製ツールを仕様することで高品質のドキュメントやスタブを自動生成できる

REST APIの開発元はSwaggerで記述することで、サードパティ製の様々なサポートツールを利用することができます。

https://qiita.com/ryan5500/items/c9f5cfb6ac1c35592d9c

https://zenn.dev/minateru/articles/github-zenn-linkage-20240111

https://zenn.dev/chida/articles/25f4016560f6bf

まさぴょんまさぴょん

VSCodeにSwaggerViewerを導入する

拡張機能Swagger Viewer を追加する

VSCode用の拡張機能「Swagger Viewer」を使うことで、VSCodeでSwaggerを編集しながらプレビューを動的に生成することができます。

Preview方法

  1. Shift+command+pでコマンドパレットを開く(WindowsはShift+Alt+p)
  2. コマンドパレットからPreview Swaggerを選択

https://zenn.dev/nekoniki/articles/acd946cc349d1e

Swagger Editor

https://editor.swagger.io/

参考・引用

https://zenn.dev/collabostyle/articles/42f155b7d84c4f

https://note.com/npaka/n/n52abf0f49f0c