OAI / OAI/OpenAPI-Specification
No provision to group API's and then $ref it to reference it in other file
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Markdown
- Estrellas
- 31.2k
- Forks
- 9.2k
- Merge medio
- 6 h 37 min
- PR fusionados (30 d)
- 27
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la estructura $ref agrupada propuesta en el issue y las reglas de referencia de OpenAPI; después determina si la solicitud requiere un cambio en la especificación o solo una desreferenciación externa. Se consideraría terminado cuando exista una resolución aprobada por los maintainers y un comportamiento documentado; el issue no menciona archivos de implementación ni pruebas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- openapi
- Área
- api, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100