Dlaczego v2/api-docs jest domyślnym adresem URL podczas korzystania z Springfox i Swagger2?

Question

Właśnie zaczynam używać przekrętu po tym guide, ale odkryłem coś bardzo dziwnego, co nie ma dla mnie sensu.

O ile pamiętam, v2/api-docs powinny być używane, gdy masz dokumenty o wersji numer 2 twojego API.

Domyślnie powinno to być tylko api-docs, ale z jakiegoś dziwnego powodu znalazłem, że domyślnie jest to v2/api-docs.

Sprawdzanie dokumentacji do biblioteki Znalazłem this.

Jak przesłonić tę wartość, aby później nie móc korzystać z wersji 2? (kiedy mój API osiągnie v2, ale chcę też pokazać starsze dokumenty).

A może moja koncepcja używania v2 jest błędna? Czy ktoś może mi w tym pomóc?

Answer 1

Adres URL jest domyślnie używany przez SpringFox do dokumentacji. Wersja v2 nie odnosi się do wersji dokumentacji interfejsu API (którą można zmienić w konfiguracji Docket), ale do wersji specyfikacji Swagger. Spójrz na documentation here, aby dostosować adres URL dokumentacji Swagger. Krótko mówiąc, trzeba zmodyfikować właściwości środowiska, aby zmienić adres URL dokumentacja pojawią się:

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

Będzie to zmienić domyślny adres URL dokumentacji SpringFox Swagger od /v2/api-docs aby cokolwiek określić. Aby to realizować, dodać powyższą nieruchomość do nowego lub istniejącego pliku właściwości, a następnie dodać go jako źródło nieruchomości w swojej klasie konfiguracji Springfox:

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