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
Leave a comment