Skip to content

Commit

Permalink
docs: readmeを更新
Browse files Browse the repository at this point in the history
  • Loading branch information
rito528 committed Jun 14, 2024
1 parent 6ffd42e commit 4532bb8
Showing 1 changed file with 9 additions and 26 deletions.
35 changes: 9 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,10 @@

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

## 実装について
## API 定義について

スキーマは、[OpenAPI v3.0.3](https://spec.openapis.org/oas/v3.0.3)で記載されています。

[GitHub Pages上に公開](https://giganticminecraft.github.io/seichi-api-schema/)もされており、視覚的に確認できるようになっています。これは`main`ブランチに更新があると、自動的にGitHub Actionsによって反映されます。

### スキーマの構造

```tree
├── openapi.yml: 大元のファイル。ここでそれぞれのエンドポイントを指定している。
└── paths: 各エンドポイントごとにディレクトリも区切っている。
├── forms: フォームに関連するもの
│ ├── eachForm.yml: フォームIDを指定して操作するもの
│ ├── index.yml: フォームIDを指定しないで操作するもの
│ └── types: 各スキーマで再利用できる型をまとめている
│ ├── ...
├── healthCheck: サーバーが起動しているかを確認する
│ └── index.yml
└── reCaptcha: Google reCaptchaの認証に使用する
└── index.yml
```
API の定義には [TypeSpec](https://typespec.io/) を使用しています。
TypeSpec については[公式ドキュメント](https://typespec.io/docs)を参照してください。

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

Expand All @@ -34,12 +17,12 @@

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

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

## ライセンス

Expand Down

0 comments on commit 4532bb8

Please sign in to comment.