java - ¿Por qué v2/api-docs es la URL predeterminada al usar springfox y Swagger2?

Question

Estoy empezando a usar Swagger siguiendo esta guide , pero descubrí algo muy extraño que no tiene sentido para mí.

Por lo que recuerdo, el v2 / api-docs debe usarse para cuando tenga documentos de la versión número 2 de su API.

Entonces, el valor predeterminado debería ser solo api-docs, pero por alguna extraña razón, encontré que el valor predeterminado es v2 / api-docs.

Comprobando el documento de la biblioteca encontré this .

¿Cómo anulo ese valor sin más tarde no poder usar v2? (cuando mi API alcance un v2 pero también quiero mostrar los documentos heredados).

O tal vez mi concepto de usar v2 es incorrecto? ¿Puede alguien ayudarme con esto?

Answer 1

La URL /v2/api-docs es el valor predeterminado que SpringFox usa para la documentación. El v2 no se refiere a la versión de documentación de su API (que se puede cambiar en la configuración de Docket ), sino a la versión de la especificación Swagger que se está utilizando. Eche un vistazo a la documentación aquí para personalizar la URL de la documentación de Swagger. En resumen, debe modificar una propiedad de entorno para cambiar la URL en la que aparecerá la documentación:

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

Esto cambiará la URL predeterminada para la documentación de SpringFox Swagger de /v2/api-docs a lo que usted especifique. Para implementar esto, agregue la propiedad anterior a un archivo de propiedades nuevo o existente, y luego agréguela como fuente de propiedad en su clase de configuración de Springfox:

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