このリポジトリは、Seichi Portal において、フロントエンドとバックエンド間の通信に必要なスキーマの定義を行っています。
プロジェクトの目的やフロントエンド・バックエンドなどの関連リポジトリについては、こちらのリポジトリを参照してください。
API の定義には TypeSpec を使用しています。 TypeSpec については公式ドキュメントを参照してください。
seichi-portal-api-schema は GitHub Pages によって redocly が提供する形式で公開されています。
compile-and-up-compose.sh を起動することでスキーマを視覚的に確認することができます。
シェルスクリプトを使用してコンテナを起動したら、http://localhost:8081 または http://localhost:8082 にアクセスすると開くことができます。
それぞれの違いは以下の通りです。
- 8081
- Swagger が提供するイメージを利用するコンテナです。
- バックエンドサーバーが起動していれば、画面から実際にバックエンドに向けてリクエストを送信することができます。
- 8082
- redocly が提供するイメージを利用するコンテナです。
- Swagger のものに比べて、見やすくなっています。