openapi に慣れるための練習リポジトリ
以下が必要です。
- Docker
- Docker Compose
Dockerのインストール方法はこちら
- envファイル作成
$ cp .env.example .env
ポートを変えたい場合は適宜ファイル中のPORT
を書き換える.
- dockerコンテナを立ち上げる
$ docker-compose up -d
- localhost:{PORT} にアクセス
- 色々触ってみる
こちらを参考に色々とAPIの定義を書いて練習しましょう.
./docs/spec.json
を編集し、ブラウザをリロードすると変更が反映されます。
IntelliSenseを提供してくれるのでOpenAPIの仕様を覚えなくても楽に描けるようになります.