OAI / OAI/OpenAPI-Specification
No provision to group API's and then $ref it to reference it in other file
まだ誰も着手していません。
- 主要言語
- Markdown
- スター
- 31.2k
- フォーク
- 9.2k
- 平均マージ
- 6時間 37分
- マージ済み PR(30日)
- 27
説明
In our application, we have apis divided among various modules.
As per swagger-spec, It becomes very difficult to have only one swagger file (api-docs) for all the modules considering the number of apis and also number of teams working on various modules.
So I started using $ref (purpose: same folder reference) and third party swagger parsers to dereference it. But I still cannot figure out a way in swagger to group apis with one $ref.
So that I can assign all apis for a particular module to a team and then just $ref in api-docs that can be dereferenced lately to get complete single api-docs file
Eg:
//something like that
{
'pet' : '$ref': './pet.json',
'user' :'$ref': './user.json'
}
Which when dereferenced, will change to
{
'/pet' : {},
'/pet/{name}' : {},
'change/pet' : {},
'/user': {},
'/user/data': {}
}
Any help would be appreciated.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue で提案されているグループ化された $ref 構造と OpenAPI の参照ルールから始め、次に、その要求に仕様の変更が必要なのか、それとも外部デリファレンスだけでよいのかを判断します。完了の条件は、maintainers が承認した解決策と、文書化された動作です。Issue には実装ファイルやテストの指定はありません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi
- 領域
- api, documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100