shirobrak / openapi-tutorial

openapi 練習環境

openapi-tutorial

openapi に慣れるための練習リポジトリ

Requirements

以下が必要です。

• Docker
• Docker Compose

Dockerのインストール方法はこちら

Get started

1. envファイル作成

$ cp .env.example .env

ポートを変えたい場合は適宜ファイル中のPORTを書き換える.

2. dockerコンテナを立ち上げる

$ docker-compose up -d

3. localhost:{PORT} にアクセス

4. 色々触ってみる

こちらを参考に色々とAPIの定義を書いて練習しましょう.

./docs/spec.json を編集し、ブラウザをリロードすると変更が反映されます。

Recommend extensions for VsCode users

OpenAPI (Swagger) Editor

IntelliSenseを提供してくれるのでOpenAPIの仕様を覚えなくても楽に描けるようになります.