Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BirdXplorer OpenAPI Spec から API クライアントを生成する #9

Open
sushichan044 opened this issue Dec 6, 2024 · 2 comments · May be fixed by #10
Open

BirdXplorer OpenAPI Spec から API クライアントを生成する #9

sushichan044 opened this issue Dec 6, 2024 · 2 comments · May be fixed by #10
Assignees
@sushichan044

Comments

@sushichan044
Copy link
Collaborator

sushichan044 commented Dec 6, 2024 •
edited
Loading

Outline

  • すでに BirdXplorer 側に OpenAPI Spec があるので、コード生成ライブラリを使ってリクエストに TypeScript の型を被せる
  • コード生成ライブラリは OpenAPI 3.1 に対応済みのものを使う
    • React Query の hooks を吐き出せるものを使用したい
  • (optional) BirdXPlorer 側で API 仕様に差分が出たら自動でコード生成し直して PR を作る GitHub Actions を作成したい
@sushichan044 sushichan044 self-assigned this Dec 6, 2024
@sushichan044 sushichan044 mentioned this issue Dec 6, 2024
Open
@sushichan044
Copy link
Collaborator Author

sushichan044 commented Dec 6, 2024 •
edited
Loading

コード生成元の openapi json はどちらを使う？

  • 本番環境の openapi.json
  • BirdXplorer のリポジトリに openapi.json をコミットするようにして raw github content

@sushichan044 sushichan044 linked a pull request Dec 11, 2024 that will close this issue
Open
@sushichan044
Copy link
Collaborator Author

ひとまず 本番環境の openapi json から直接生成

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sushichan044 sushichan044

Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@sushichan044