OpenAPIのスキーマを分割・構造化していく方法 | GiFT(ギフト)株式会社

前の記事でOpenAPIのスキーマを中心に開発を進める方針についてに書きました。 OpenAPIやSwaggerのファイルを記述していくとよくあるつらい点は、内容に対してファイルが肥大化しやすいことだと思います。（エンドポイントはそんなにないのに数百行とか😇） 上記のファイルが大きくなるというつらみは結構深刻な問題だと考えているので、 $ref を使ってファイルを分割しつつスキーマを書いていく方針にしようかと思っています。 Using $refただ、現状OpenAPIと連携できるツールでもファイルの参照を解釈できるものがあまりなさそうなので結局1つのファイルにしておくと使いやすいかなとも考えています。 ということで、ファイルを分割してスキーマを管理しつつ最終的に1つのスキーマとして結合する方法を試してみました。 ファイルを分割してスキーマを管理するまずファイルを分割してスキーマを管理する

[nc44v-134-nvtyqfgq]

openapi.yamlを分割して管理する方法。分割して管理するがopenapi-generatorを用いてopenapi.yamlを生成する。書いている過程はchokidarでwatchする手法。

[yojik]

“ $ref: ./paths/users-by-id.yml ”

[kura709]

スキーマファースト開発する際に