OAI / OAI/OpenAPI-Specification
No provision to group API's and then $ref it to reference it in other file
Personne n'a encore pris cette issue.
- Langage dominant
- Markdown
- Étoiles
- 31.2k
- Forks
- 9.2k
- Merge moyen
- 6 h 37 min
- PR mergées (30 j)
- 27
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la structure $ref groupée proposée dans l’issue et par les règles de référence d’OpenAPI, puis déterminez si la demande nécessite une modification de la spécification ou uniquement une déréférenciation externe. La tâche serait considérée comme terminée lorsqu’une résolution approuvée par les maintainers et un comportement documenté existeraient ; l’issue ne nomme aucun fichier d’implémentation ni aucun test.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- openapi
- Domaine
- api, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100