swagger

最新推荐文章于 2025-01-24 17:09:14 发布

原创最新推荐文章于 2025-01-24 17:09:14 发布 · 80 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

使用swagger接口文档

一: 导入依赖

	<!--  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>

        <!--  swagger bootstrap ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.2</version>
        </dependency>

二: swagger配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket adminApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("组名称")
                .apiInfo(adminApiInfo())
                .select()
                .paths(Predicates.and(PathSelectors.regex("配置什么路径下的类生成swagger")))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder().title("标题")
                .description("描述")
                .version("1.0")
                .contact(new Contact("Helen", "http://baidu.com","admin@admin.com"))
                .build();
    }
}

三: controller示例

@Api(tags = "控制器名称")
public class LoginController {
    @ApiOperation(value = "移动端账号密码登录", notes = "移动端账号密码登录")
    @PostMapping("/login/accountLogin")
    public R accountLogin(
            @ApiParam(value = "账号", required = true)
            @RequestBody UserBean userBean
    ) {
        
    }
}

四: 其他的类可以使用mybatisPlus生成时配置swagger生成的配置

五: 如果配置了拦截器的话,可以放行以下配置,不会拦截swagger配置路径

public void addInterceptors(InterceptorRegistry registry) {
    // 添加自定义拦截器，并拦截对应 url
    registry.addInterceptor(interceptor).addPathPatterns("/move/**") // 拦截的路径
            .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**"); // 放行swagger路径
  }