springfox-swagger

文档

http://springfox.github.io/springfox/docs/current/#springfox-swagger-ui

pom.xml

2.*

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

3.*

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

config

ui页面地址在springfox.boot.starter.autoconfigure.SwaggerUiWebMvcConfigurer

2.*

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        //文档信息
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("文档标题")
                .description("文档描述")
                .version("1.0")
                .build();

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("包r"))
                .paths(PathSelectors.any())
                .build();
    }
}

3.*

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket Api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .pathMapping("/");
    }
}

controller

@Api(description = "描述类")
@RestController
public class Controller {
    @ApiOperation("描述方法")
    @ApiResponses(
            {@ApiResponse(code = 200, message = "描述响应")
     })
    @GetMapping("/string/{string}")
    public ResponseEntity<String> function(@ApiParam("描述参数") @PathVariable("string") String string) {
        return ResponseEntity.ok( string);
    }
}