前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >九. 配置swagger生成api文档

九. 配置swagger生成api文档

作者头像
用户8988577
发布2022-12-27 15:58:29
5400
发布2022-12-27 15:58:29
举报
文章被收录于专栏:言云纪言云纪

前言

项目开发中需要写一些api开发文档,如果不写的话容易忘记这个接口的请求方法以及参数等。本期利用swagger生成实时api文档

导入pom依赖

代码语言:javascript
复制
        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

配置swagger控制器

代码语言:javascript
复制
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("online")
                .description("在线视频api接口文档")
                .termsOfServiceUrl("https://tanblog.cc")
                .version("1.0")
                .build();
    }
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cc.tanblog.online"))
                .paths(PathSelectors.regex(".*"))
                .build();
    }
}

token拦截器放行

WebConfiguration

代码语言:javascript
复制
    /**
     * 配置拦截器、拦截路径
     * 每次请求到拦截的路径,就会去执行拦截器中的方法
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        List<String> excludePath = new ArrayList<>();
        //排除拦截,除了注册登录(此时还没token),其他都拦截
        excludePath.add("/swagger-ui.html");
        excludePath.add("/swagger-resources/**");
        excludePath.add("/v2/**");
        excludePath.add("/doc.html/**");
        excludePath.add("/webjars/**");
        excludePath.add("/usercontroller/login");  //登录

        registry.addInterceptor(tokenInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns(excludePath);
        WebMvcConfigurer.super.addInterceptors(registry);
    }

查看效果

浏览器访问:http://127.0.0.1:8080/swagger-ui.html 效果图如下

swagger
swagger
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2022-10-05,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 导入pom依赖
  • 配置swagger控制器
  • token拦截器放行
  • 查看效果
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档