OpenAPIスキーマ定義ファイルをTSファイルに変換する技術選定

a-yossy / dutch_account

0 stars 0 forks source link

OpenAPIスキーマ定義ファイルをTSファイルに変換する技術選定 #6

Closed a-yossy closed 2 years ago

a-yossy commented 2 years ago

どの技術が良いか選定を行なっていく

a-yossy commented 2 years ago

候補

選択した技術

openapi-generator

理由

導入実績が多い
openapi-generatorの方が開発に力を入れていそう
- https://openapi-generator.tech/docs/fork-qna
  
  The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.

a-yossy commented 2 years ago

@YuyaYoshioka こんな感じになったよ → PR作ることに

a-yossy commented 2 years ago

npm swagger codegenというのはないのか(スター数が少ない) https://github.com/steve-gray/swagger-codegen

openapi-generatorを使い以下の2つを検証する

TypeScript (Axios):
- 9
TypeScript (Fetch):
- 8
  
  https://zenn.dev/syu/articles/9840082d1a6633

→違った、これだった

aspida
- 10

typescript専用なのか https://tech.mobilefactory.jp/entry/2021/12/10/000000 https://zenn.dev/solufa/articles/getting-started-with-aspida

選定結果

aspida

理由

Typescript専用で型がより堅牢になる
新しい(今回の開発では新しい技術を多く取り入れるのが目標のため)

懸念箇所

requestBodiesスキーマの型が作成されていない
- 該当箇所：https://github.com/atsuya02/dutch-account-app/pull/10/files#diff-b95e842e9760429269228ae1df1000aae95b42937b1e3594087237626270d83dR1-R21
- githubでもissueが上がっていた https://note.com/mh4gf/n/n9828a258481d

a-yossy commented 2 years ago

@YuyaYoshioka こんな感じになったよ

懸念箇所

requestBodiesスキーマの型が作成されていない

該当箇所：https://github.com/atsuya02/dutch-account-app/pull/10/files#diff-b95e842e9760429269228ae1df1000aae95b42937b1e3594087237626270d83dR1-R21

githubでもissueが上がっていた https://note.com/mh4gf/n/n9828a258481d

ここはどうするか迷ってる

openapi.ymlでrequestBodiesスキーマを使わない
自動生成された型に手動で変更を加える

今回そんなに種類多くないし2番にしようかなと考えているわ

YuyaYoshioka commented 2 years ago

@atsuya02

自動生成された型に手動で変更を加える

これはやめた方がいいのでは？リクエスト・レスポンスの型を自分で書きたくないから自動生成できるもの使おうとしてるのに，それを手で書き直したら，本末転倒な気がする。

a-yossy commented 2 years ago

(口頭メモ)

requestBodiesはopenapi-generatorでは問題なく生成されている
一度変換するだけだから新しい技術をそこまで気にしなくていい

という理由でopenapi-generatorを使うことになった