swagger【个人笔记】

swagger

网址：https://swagger.io

导入mave坐标

在配置类(WebMvcConfiguration)中加入knife4j相关配置

    /**
     * 、@Bean:标识由spring框架创建这个对象，并管理这个对象
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)///指定了swagger 的版本
                .apiInfo(apiInfo)
                .select()
                ///指定生成接口需要的包，有子包也会一起扫描
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

设置静态资源映射，主要是让拦截器放行

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

swagger 常用注解

@Api(tags = “[描述这个类的作用]”)

用在类上，例如Controller,表示对类的说明，说明要写在tags

@ApiModel(description = “[描述这个类的作用]”)

用在类上，例如 entity,DTO,VO

@ApiModelProPerty(“描述这个类的作用”)

用在属性上，描述信息

@ApiOperation(“[描述方法的作用]”)

用在方法上，例如Controller的方法，说明方法的用途、作用