Spring Boot and Swagger in JAVA

Spring Boot and Swagger in JAVA

Followed this document
https://springframework.guru/spring-boot-restful-api-documentation-with-swagger-2/

Find some examples
https://github.com/springfox/springfox-demos

Git clone the base project to local
> git clone https://github.com/springfox/springfox

Build and generate package to local maven
> ./gradlew clean build publishToMavenLocal -i

Then I can import and check the example project as follow
springfox-demos/springfox-integration-webflux

Usually the generated documents will be here
http://localhost:8080/v2/api-docs

The Swagger UI will be here
http://localhost:8080/swagger-ui.html#/

More annotation example
https://github.com/swagger-api/swagger-core/wiki/annotations#quick-annotation-overview

Here is my working Swagger Configuration.
<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>

Swagger Configuration
package com.kikokang.connector.netsuite.config;

import static com.google.common.base.Predicates.not;
import static springfox.documentation.builders.PathSelectors.regex;
import static springfox.documentation.builders.RequestHandlerSelectors.basePackage;

import java.util.Collections;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select().apis(not(basePackage("org.springframework.boot")))
                .paths(not(regex("/error"))).build().apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfo("Netsuite Connector RESTful API", null, "API V1", null, null, null, null,
                Collections.emptyList());
    }

}

In the Controller
@Api(value = "/api/customer/")

@ApiOperation(value = "Get Customer", response = com.kikokang.connector.netsuite.model.CustomerDTO.class)
@GetMapping(path = "/v1/{id}", produces = MediaTypes.JSON_UTF_8)
public Mono<CustomerDTO> get(@ApiParam(defaultValue = "1525", required = true) @PathVariable("id") String id,
@ApiParam(defaultValue = “xxxx1", required = true) @RequestHeader(name = "account", required = false) String account,
@ApiParam(defaultValue = “xxxx2", required = true) @RequestHeader(name = "tbaConsumerKey", required = false) String tbaConsumerKey,
@ApiParam(defaultValue = “xxxx3", required = true) @RequestHeader(name = "tbaConsumerSecret", required = false) String tbaConsumerSecret,
@ApiParam(defaultValue = “xxxx4", required = true) @RequestHeader(name = "tbaTokenId", required = false) String tbaTokenId,
@ApiParam(defaultValue = “xxxx5", required = true) @RequestHeader(name = "tbaTokenSecret", required = false) String tbaTokenSecret) {
LOGGER.info("account:" + account + " tbaConsumerKey:" + tbaConsumerKey + " tbaConsumerSecret:"
+ tbaConsumerSecret + " tbaTokenId:" + tbaTokenId + " tbaTokenSecret:" + tbaTokenSecret);
if (!WebUtil.validateHeader(account, tbaConsumerKey, tbaConsumerSecret, tbaTokenId, tbaTokenSecret)) {
return Mono.error(new HeaderMissingException("Token and ConsumerKey missing in Header"));
}
HeaderDO header = WebUtil.getHeaderDO(account, tbaConsumerKey, tbaConsumerSecret, tbaTokenId, tbaTokenSecret);
try {
Customer customer = customerService.getByID(id, header);
CustomerDTO returnDto = CustomerTransform.convertToCustomerDTO(customer);
return Mono.just(returnDto);
} catch (ServiceException e) {
LOGGER.error("ServiceException", e);
return Mono.error(e);
}
}



References:
https://sillycat.iteye.com/blog/2247372
https://github.com/springframeworkguru/springboot_swagger_example
https://springframework.guru/spring-boot-restful-api-documentation-with-swagger-2/
https://swagger.io/