Swagger UI – prosty sposób na wizualizację API

Swagger UI – prosty sposób na wizualizację API

Swagger firmy SmartBear to świetne narzędzie które pozwala na szybkie tworzenie interaktywnej dokumentacji do swojego API.

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
 
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

Klasa konfiguracyjna SwaggerConfig – licencja, opis, forma kontaktu itp.:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
 
    @Bean
    public Docket postsApi() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("public-api")
                .apiInfo(apiInfo()).select().paths(postPaths()).build();
    }
 
    private Predicate<String> postPaths() {
        return or(regex("/api.*"));
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("Javaleader.pl - api")
                .description("Swagger example REST API")
                .termsOfServiceUrl("https://javaleader.pl")
                .contact("kontakt@javaleader.pl").license("License API")
                .licenseUrl("https://javaleader.pl").version("1.0").build();
    }
}

API prefiksowane przedrostkiem „api” zostanie zawarte w dokumentacji Swaggera np.:

@RestController
@RequestMapping("/api")
public class RestApiController {
    ...

Adres pod którym dokumentacja jest dostępna to:

http://localhost:9872/swagger-ui.html

Zobacz kod na GitHubie i zapisz się na bezpłatny newsletter!

.

Leave a comment

Your email address will not be published.


*


Ta strona wykorzystuje pliki cookie. Używamy informacji zapisanych za pomocą plików cookies w celu zapewnienia maksymalnej wygody w korzystaniu z naszego serwisu. Mogą też korzystać z nich współpracujące z nami firmy badawcze oraz reklamowe. Jeżeli wyrażasz zgodę na zapisywanie informacji zawartej w cookies kliknij na „akceptuję". Jeśli nie wyrażasz zgody, ustawienia dotyczące plików cookies możesz zmienić w swojej przeglądarce. kliknij po więcej informacji

Ta strona wykorzystuje pliki cookie. Używamy informacji zapisanych za pomocą plików cookies w celu zapewnienia maksymalnej wygody w korzystaniu z naszego serwisu. Mogą też korzystać z nich współpracujące z nami firmy badawcze oraz reklamowe. Jeżeli wyrażasz zgodę na zapisywanie informacji zawartej w cookies kliknij na „akceptuję". Jeśli nie wyrażasz zgody, ustawienia dotyczące plików cookies możesz zmienić w swojej przeglądarce.

zamknij