swagger

1、导入依赖

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

2、swagger配置类

@Configuration
@EnableSwagger2
public class Swagger2Config implements WebMvcConfigurer {

    /**
     * 解决Swagger访问页面，响应码404问题
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations(
                "classpath:/static/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations(
                "classpath:/META-INF/resources/webjars/");
    }

    /**
     * 生成api
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描指定包路径下的api，生成接口文档
                //.apis(RequestHandlerSelectors.basePackage("org.saic.sce.service.sys.business.BusinessController"))
                //扫描加了swagger注解的api，更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //扫描所有
                //.apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 摘要信息
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //设置标题
                .title("MY接口API")
                //描述
                .description("MY业务接口文档")
                //作者信息
                .contact(new Contact("","",""))
                //版本
                .version("1.0")
                .build();
    }

}

3、请求参数模型和实体类等

@Data
@ApiModel(value = "TeacherModel",description = "teacher请求参数模型")
public class TeacherModel {
    /**
     * 属性描述和是否必填
     */
    @ApiModelProperty(value = "teacher名字",required = true)
    private String name;
}

/**
 * @author naxiaohuozhenshuai
 */
@Data
@AllArgsConstructor
@NoArgsConstructor

@ApiModel(value = "Teachers",description = "teachers信息")
public class Teachers {

    @ApiModelProperty(value = "姓名")
    private String name;

    @ApiModelProperty(value = "年龄")
    private int age;

    @ApiModelProperty(value = "体重")
    private int weight;

    @ApiModelProperty(value = "地址")
    private String address;
}

4、创建controller

@RestController
@Api(tags = "我是swagger单元标题")
@RequestMapping(value = "/test/teacher")
public class TeacherController {

    @ApiOperation(value = "获取teacher信息")
    @PostMapping(value = "/getTeacherInfo")
    public Teachers getTeacher(@RequestBody TeacherModel teacherModel){
        //取出请求模型中的参数
        String name = teacherModel.getName();
        //业务处理...
		//随便返回点数据
        return new Teachers("张三",21,101,"zz");
    }
}

5、运行项目，swagger的小问题挺多的，启动报错大概率是依赖冲突的问题，下个插件排查一下就行了

6、访问swagger页面，默认本地是
localhost:8080/swagger-ui.html

点击try it out

填写提示的参数模型点击下方的execute执行

得到结果