OAI / OAI/OpenAPI-Specification
No provision to group API's and then $ref it to reference it in other file
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Markdown
- Star
- 31.2k
- Fork
- 9.2k
- Merge trung bình
- 6 giờ 37 phút
- Pull request đã merge (30 ngày)
- 27
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với cấu trúc $ref được nhóm như đề xuất trong issue và các quy tắc tham chiếu của OpenAPI, sau đó xác định liệu yêu cầu có cần thay đổi đặc tả hay chỉ cần dereferencing bên ngoài. Công việc được xem là hoàn tất khi có một phương án được maintainers phê duyệt và hành vi được ghi lại trong tài liệu; issue không nêu tệp triển khai hoặc các bài kiểm thử.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- openapi
- Lĩnh vực
- api, documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100