Skip to content

Commit

Permalink
docs: README.mdにTypeSpecによるopenapi.yamlの生成について記載する
Browse files Browse the repository at this point in the history
  • Loading branch information
rito528 committed Jun 23, 2024
1 parent e8f57c9 commit c6e6c5d
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# seichi-portal-api-schema

このリポジトリは、Seichi Portalにおいて、フロントエンドとバックエンド間の通信に必要なスキーマの定義を行っています。
このリポジトリは、Seichi Portal において、フロントエンドとバックエンド間の通信に必要なスキーマの定義を行っています。

プロジェクトの目的やフロントエンド・バックエンドなどの関連リポジトリについては、[こちらのリポジトリ](https://github.com/GiganticMinecraft/seichi-portal)を参照してください。

Expand All @@ -11,18 +11,20 @@ TypeSpec については[公式ドキュメント](https://typespec.io/docs)を

### ローカルで確認する

`docker compose`を利用することで、ローカル環境で、スキーマを視覚的に確認することができます。
`docker compose` を利用することで、ローカル環境で、スキーマを視覚的に確認することができます。

`docker compose up -d`で、コンテナを起動したら、`http://localhost:8081`または`http://localhost:8082`にアクセスすると開くことができます。
docker を使用する前に seichi-portal-api-schema のルートディレクトリで `tsp compile .` を実行し、`openapi.yaml`を生成する必要があります。

`docker compose up -d` で、コンテナを起動したら、`http://localhost:8081` または `http://localhost:8082` にアクセスすると開くことができます。

それぞれの違いは以下の通りです。

- 8081
- Swaggerが提供するイメージを利用するコンテナです
- バックエンドサーバーが起動していれば、画面から実際にバックエンドに向けてリクエストを送信することができます。
- Swagger が提供するイメージを利用するコンテナです
- [バックエンドサーバー](https://github.com/GiganticMinecraft/seichi-portal-backend)が起動していれば、画面から実際にバックエンドに向けてリクエストを送信することができます。
- 8082
- redoclyが提供するイメージを利用するコンテナです
- Swaggerのものに比べて、見やすくなっています。
- redocly が提供するイメージを利用するコンテナです
- Swagger のものに比べて、見やすくなっています。

## ライセンス

Expand Down

0 comments on commit c6e6c5d

Please sign in to comment.