Skip to content

Commit

Permalink
docs: API定義がGitHub Pagesによって公開されていることを記載
Browse files Browse the repository at this point in the history
  • Loading branch information
rito528 committed Jun 23, 2024
1 parent c6e6c5d commit 248be11
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
API の定義には [TypeSpec](https://typespec.io/) を使用しています。
TypeSpec については[公式ドキュメント](https://typespec.io/docs)を参照してください。

### リモートで確認する

seichi-portal-api-schema は GitHub Pages によって redocly が提供する形式で公開されています。

[GitHub Pages上の定義はこちら](https://giganticminecraft.github.io/seichi-portal-api-schema/)

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

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

0 comments on commit 248be11

Please sign in to comment.