前后端开发文档管理swagger

1.引入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
           

2.运行程序

进入http://localhost:8081/swagger-ui/index.html

如配置security需要配置忽略

public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/index", "/login", "/swagger**/**", "/v3/**", "/webjars/**", "/doc.html");
    }

           

3.文档配置

@Configuration
public class SwaggerConfig {
    @Bean
    Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.khm.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(
                        new ApiInfoBuilder()
                                .title("api测试文档")
                                .description("JJBlog")
                                .version("v1.0")
                                .contact(new Contact("khm", "http://www.khm.org", "[email protected]"))
                                .license("Apache 2.0")
                                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                                .build()
                );
    }
}
           

4.基本注解

标注用在哪些地方

类：@Api(tags = "CategoryController")
    方法：@ApiOperation(value = "新增接口",notes = "新增类别")
    方法：@Operation(summary = "新增接口",description = "新增类别")
    方法：@ApiImplicitParam(name = "jjCategory",value = "path(路径),body(json),query(key-value)",required = true)
    参数：@ApiParam("页码")
    实体类：@ApiModel
    实体类属性：@ApiModelProperty(value = "cname",name = "类别名称")