web-dev-qa-db-fra.com

Pourquoi v2 / api-docs est-il l'URL par défaut lors de l'utilisation de springfox et Swagger2?

Je commence juste à utiliser Swagger après cela guide , mais j'ai découvert quelque chose de très bizarre qui n'a aucun sens pour moi.

Pour autant que je me souvienne, les v2/api-docs devraient être utilisés lorsque vous avez des documents de la version numéro 2 de votre API.

Ainsi, la valeur par défaut ne devrait être que des api-docs, mais pour une raison étrange, j'ai trouvé que la valeur par défaut est v2/api-docs.

Vérification du document de bibliothèque que j'ai trouvé ceci .

Comment remplacer cette valeur sans pouvoir ultérieurement utiliser la v2? (quand mon API atteindra une v2 mais je voudrai aussi montrer les documents hérités).

Ou peut-être que mon concept d'utiliser la v2 est faux? Quelqu'un peut il m'aider avec ça?

24
jpganz18

Le /v2/api-docs URL est la valeur par défaut que SpringFox utilise pour la documentation. Le v2 ne fait pas référence à la version de la documentation de votre API (qui peut être modifiée dans la configuration Docket), mais à la version de la spécification Swagger utilisée. Jetez un œil à la documentation ici pour personnaliser l'URL de la documentation Swagger. En bref, vous devez modifier une propriété d'environnement pour changer l'URL de votre documentation apparaîtra à:

springfox.documentation.swagger.v2.path=/my/docs

Cela changera l'URL par défaut de la documentation SpringFox Swagger de /v2/api-docs à ce que vous spécifiez. Pour l'implémenter, ajoutez la propriété ci-dessus à un fichier de propriétés nouveau ou existant, puis ajoutez-la en tant que source de propriété dans votre classe de configuration Springfox:

@PropertySource("classpath:swagger.properties")
@Configuration
public class SwaggerConfig {...}
40
woemler