APIドキュメントについて

目的

OpenAPIを利用してAPIドキュメントを作成することで、フロントエンドとバックエンドの実装を隠蔽し、APIの定義をインターフェースとして利用することにより、開発効率を向上させる。

仕様

• OpenAPI 3.0.0
• ファイル形式: YAML
• ファイル名: documentation.yaml
• ファイルの配置場所: /swagger

ファイル構成

/components: OpenAPIのコンポーネントを定義する
/paths: APIのエンドポイントを定義する
documentation.yaml: OpenAPIの定義を記述するファイル

APIドキュメントの確認方法

Github Pagesで確認する方法

masterブランチのAPIドキュメントについてはこちらで確認できます。

ローカルで確認する方法

1. cd swaggerでswaggerディレクトリに移動します
2. npx @redocly/cli preview-docs documentation.ymlを実行します
3. http://localhost:8080/にアクセス