openapi をファイル分割する

sunakan commented 1 year ago

目的

リクエスト毎に分ける
- path自体はフラットにするが、ディレクトリとする
- HTTP メソッドでファイルを表現する（getpost.yml や postpost.ymlなど考えたが、ソートした時見づらいと考えた）
レスポンスで利用するモデルは共通して使いたいので、別途分けて管理する（そして同じものを使う）
- 無理に同じものを使う必要はない
- RESTっぽくないリクエストで、そのURL特有のレスポンスの場合は、リクエストの方に一緒に記述する
もしリクエストパラメータにバリデーションをつけることができるようになったら、共通化してファイルとして切り出す
例：（新規作成と更新時の）テキストの文字数は同じものを指しているはずなので、バリデーションも共通化したい

sunakan commented 1 year ago

OpenAPI Generator と相性悪い。。ぐぬぬ

sunakan commented 1 year ago

Caused by: java.lang.RuntimeException: Could not find openapi.yml#components/schemas/Post on the classpath

sunakan commented 1 year ago

OpenGenerator を優先すると Swagger UIのほうがうまく行かない

sunakan commented 1 year ago

Swagger UIを優先すると OpenAPI Generator のほうがうまく行かない

sunakan commented 1 year ago

merger 使ってうまくできないかな

sunakan commented 1 year ago

components:
  schemas:
    Post:
      $ref: './components/schemas/post.yml'
    PostResponse:
      $ref: './components/schemas/post-response.yml'

こんな風にして、post.yamlは

post:
  required:
    - id
    - imagePath

は駄目(Post/Postとネストしてしまう）

required:
  - id
  - imagePath

とする必要がある

sunakan commented 1 year ago

components:
  schemas:
    Post:
      $ref: './components/schemas/post.yml'
    PostResponse:
      $ref: './components/schemas/post-response.yml'

だと、PostResponseクラスではなく、PostMinusResponseクラスができてしまう

=> ファイル名とクラス名は合わせるべきかも

sunakan commented 1 year ago

merged.yamlをOpenAPI Generatorに使った場合

PostResponseが参照するのはPostじゃなくなりそう

試す

sunakan commented 1 year ago

data class AllPost200ResponsePostsInner(

みたいなやつができた

これはOUT

sunakan commented 1 year ago

ついでに HTTP method の方も合わせて大文字にしても良さそう