当前位置: 首页 > article >正文

swagger使用手册

1.导入依赖

   <!--引入swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2.

  • 新建一个 SwaggerConfig 类 写入下面内容

  • package com.example.hellowww.config;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /**
     * Swagger使用的配置文件
     */
    @Configuration
    @EnableSwagger2//启用Swagger2功能
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi(){
            return new Docket(DocumentationType.SWAGGER_2)
    
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com"))//com包下的所以API都交给Swagger管理
                   // .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        //API文档页面显示信息
        private ApiInfo apiInfo(){
            return new ApiInfoBuilder()
                    .title("演示项目API")
                    .description("xx相关接口的文档")
    //                .termsOfServiceUrl("http://localhost:8080/hello")
    //                .version("1.0")
                    .build();
        }
    }

    3.访问http://localhost:8089/swagger-ui.html

  • 若  启动报错Failed to start bean ‘documentationPluginsBootstrapper‘ 问题:

  • 解决 高版本SpringBoot整合Swagger 启动报错Failed to start bean ‘documentationPluginsBootstrapper‘ 问题_高版本springboot解决 documentationpluginsbootstrapper报错-CSDN博客


http://www.kler.cn/a/273011.html

相关文章:

  • D59【python 接口自动化学习】- python基础之异常
  • Rockchip SoC AI 与视觉处理器路线图:赋能未来的 AI 驱动设备
  • Ansys HFSS:外壳的屏蔽效果演示
  • nodejs入门教程4:nodejs创建第一个应用
  • 学习虚幻C++开发日志——定时器
  • ISUP协议视频平台EasyCVR视频融合平台接入各类摄像机的方法
  • 【DFS深度优先搜索专题】【蓝桥杯备考训练】:迷宫、奶牛选美、树的重心、大臣的旅费、扫雷【已更新完成】
  • Window部署AgileConfig
  • 传统电力运维企业的数字化转型案例
  • android 简单快速 自定义dialog(简单好用,不需要设置样式)
  • 滑块验证码
  • 算法之前缀和
  • TypeScript中的 K、T 、V
  • MiniGPT-5: 通过生成性视觉标记实现交错式视觉与语言生成
  • 使用wx:for()
  • redis配置文件详情
  • 全基因集GSEA富集分析
  • 基于Andriod的连锁药店管理系统(源码|论文)
  • npm WARN config init.license Use `--init-license` instead.
  • Python爬虫从基础到入门:script标签中的数据
  • Mosquitto MQTT服务器和客户端简单命令
  • 【前缀和】100255. 成为 K 特殊字符串需要删除的最少字符数
  • BUGKU-WEB cookies
  • week07day03(power bi dax公式 零售数据业务分析)
  • QT中messageBox的使用
  • web蓝桥杯真题:时间管理大师