Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec/example_project
swagger-watch
README.md
docker-compose.yml

README.md

api-spec-sample

swaggerのsampleプロジェクトです

起動方法(ローカル環境)

docker-compose up

以下のコンテナが起動します。

swagger-ui

公式へのリンク

モックサーバー

apisproutを使ってswaggerの定義ファイルからモックサーバーを起動します。

main.ymlに変更があったときに自動的にリロードするようにしています。

APIのポートはプロジェクトごとに異なるので、docker-compose.ymlを参照してください。

swagger-watch

spec/ 配下にあるymlファイルの変更を監視します。

変更を検知したら一つのymlファイル(combined.yml)に統合する処理が走ります。

ディレクトリ構成

spec配下に複数のプロジェクトの仕様書をディレクトリで分けて置いています。

このようなイメージです。

api-spec
├── spec
│   └── プロジェクト名
│       ├── combined.yml
│       ├── components
│       ├── main.yml
│       └── paths
You can’t perform that action at this time.