From c6e6c5dd1dbde8aba4d2a99231f1530e28f8ecf4 Mon Sep 17 00:00:00 2001 From: rito528 <39003544+rito528@users.noreply.github.com> Date: Sun, 23 Jun 2024 16:47:44 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20README.md=E3=81=ABTypeSpec=E3=81=AB?= =?UTF-8?q?=E3=82=88=E3=82=8Bopenapi.yaml=E3=81=AE=E7=94=9F=E6=88=90?= =?UTF-8?q?=E3=81=AB=E3=81=A4=E3=81=84=E3=81=A6=E8=A8=98=E8=BC=89=E3=81=99?= =?UTF-8?q?=E3=82=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e153d4f..a03bba4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # seichi-portal-api-schema -このリポジトリは、Seichi Portalにおいて、フロントエンドとバックエンド間の通信に必要なスキーマの定義を行っています。 +このリポジトリは、Seichi Portal において、フロントエンドとバックエンド間の通信に必要なスキーマの定義を行っています。 プロジェクトの目的やフロントエンド・バックエンドなどの関連リポジトリについては、[こちらのリポジトリ](https://github.com/GiganticMinecraft/seichi-portal)を参照してください。 @@ -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 のものに比べて、見やすくなっています。 ## ライセンス