API仕様書をサクッと作るための自分用メモ
お試し
内容が漏れてもOKなら、以下でお試し可能
Swagger Editorの公式Dockerイメージ
ローカルでSwaggerエディタ使いたい場合
$ docker pull swaggerapi/swagger-editor
$ docker run -d -p 80:8080 swaggerapi/swagger-editor
Swagger UIの公式Dockerイメージ
swaggerapi/swagger-ui - Docker Hub
手順
docker pull swaggerapi/swagger-ui
docker run -p 8001:8080 swaggerapi/swagger-ui
http://localhost:8001/ にアクセスする
open http://localhost:8001
yaml, jsonの各パラメータの意味
以下で検索
参考
- SwaggerエディターでREST APIの設計書を書いてみる | 株式会社INDETAIL - ブログ
- Dockerを使ってSwaggerの環境を整えてAPI Gatewayにインポートする ｜ Developers.IO
- SwaggerでRESTful APIの管理を楽にする - Qiita
- APIドキュメント標準化 現状確認 : エキサイト公式 エンジニアブログ
- swaggerapi/swagger-editor - Docker Hub