Go Web 框架 Gin 实践8—为它加上Swagger，帅帅的文档

一个好的 API's，必然离不开一个好的API文档

要开发纯手写 API 文档，不存在的 :=)

项目地址：>

在使用SpringBoot中配置Swagger2的时候，出现

Unable to infer base url This is common when using dynamic servlet registration or when the API is behind an API Gateway The base url is the root of where all the swagger resources are served For eg if the api is available at >

1Springboot整合Swagger2

11pom加swagger依赖

<dependency>

         <groupId>iospringfox</groupId>

         <artifactId>springfox-swagger2</artifactId>

         <version>292</version>

      </dependency>

      <!-- <dependency>

         iospringfox

         springfox-swagger-ui

         292

      -->

      <dependency>

            <groupId>comgithubxiaoymin</groupId>

            <artifactId>swagger-bootstrap-ui</artifactId>

            <version>190</version>

        </dependency>

      <dependency>

          <groupId>ioswaggercorev3</groupId>

          <artifactId>swagger-annotations</artifactId>

          <version>208</version>

      </dependency>

        <dependency>

          <groupId>ioswaggercorev3</groupId>

          <artifactId>swagger-models</artifactId>

          <version>208</version>

</dependency>

12添加swagger配置类

@Configuration

@EnableSwagger2

@EnableSwaggerBootstrapUI

//@ConditionalOnExpression("${swaggerenable:true}")

public class Swagger2 {

//    @Override 

//    public voidaddResourceHandlers(ResourceHandlerRegistry registry) { 

//       registryaddResourceHandler("swagger-uihtml")addResourceLocations("classpath:/META-INF/resources/"); 

//        registryaddResourceHandler("/webjars")addResourceLocations("classpath:/META-INF/resources/webjars/"); 

//    } 

   @Value("${swaggerenable:true}")

   private String enable;

   @Value("${swaggerbasePackage}")

   private String basePackage;

   @Bean

   public Docket createRestApi()

{

      Predicateselector= PathSelectors none ();

      if ("true"equals(enable)) {

         selector=PathSelectors any ();

      }

      //定义全局参数

       Listpars = new ArrayList<>();

          ParameterBuildertoken = new ParameterBuilder();

          tokenname("token")description("token")modelRef( new ModelRef("string"))parameterType("header")required( false )build();

          parsadd(tokenbuild());

      return new Docket(DocumentationType SWAGGER_2 )

            globalOperationParameters(pars) // 全局参数

            groupName("demo01")//指定分组

            apiInfo(apiInfo())

            select()

            apis(RequestHandlerSelectors basePackage (basePackage))

//          paths(PathSelectorsany())

            paths(selector)

            build();

   }

   private ApiInfo apiInfo() {

      return new ApiInfoBuilder()

            title("SpringBoot测试使用 Swagger2 构建RESTful API")

            description("springboot demo 接口文档")

            version("10")

            build();

   }

}

13加上swagger启用禁用开关

新建applicationproperties文件

#swagger启用禁用标识true：启用

swaggerenable=true

#swagger扫描需生成文档的包路径

swaggerbasePackage=comtjcspringbootDemocontroller

14Swagger具体注释用法

>

用法如下：

python中+=的意思:

1、两个值相加，返回值给符号左侧的变量;

2、用于字符串连接，变量值带引号，数据类型为字符串。

程序员必备接口测试调试工具: 立即使用Apipost = Postman + Swagger + Mock + JmeterApi设计、调试、文档、自动化测试工具后端、前端、测试，同时在线协作，内容实时同步

本教程 *** 作环境: windows7系统、python39版，DELL G3电脑，该方法适用于所有品牌电脑

python中+=的意思:

1、+=其实很容易理解

2、例如:

C += 01

就等于C+01=C

3、其实就是在C的本身加上01而已

然后看看输出就知道了

这里两种方式看似结果一样，但是它们的执行过程却不一样。

a = a + b 的执行过程: 会先计算 a + b 的结果，得到一个新对象，然后再赋值给 a。

a += b 的执行过程: 是直接在 a 的基础上原地加上 b，并不会开辟另外的内存空间，因为他的内部其实是调用的 __iadd__ 方法，而 __iadd__ 里面又是调用的 extend() 方法。

用法如下：

python中+=的意思:

1、两个值相加，返回值给符号左侧的变量;

2、用于字符串连接，变量值带引号，数据类型为字符串。

程序员必备接口测试调试工具: 立即使用Apipost = Postman + Swagger + Mock + JmeterApi设计、调试、文档、自动化测试工具后端、前端、测试，同时在线协作，内容实时同步

本教程 *** 作环境: windows7系统、python39版，DELL G3电脑，该方法适用于所有品牌电脑

python中+=的意思:

1、+=其实很容易理解

2、例如:

C += 01

就等于C+01=C

3、其实就是在C的本身加上01而已

然后看看输出就知道了

这里两种方式看似结果一样，但是它们的执行过程却不一样。

a = a + b 的执行过程: 会先计算 a + b 的结果，得到一个新对象，然后再赋值给 a。

a += b 的执行过程: 是直接在 a 的基础上原地加上 b，并不会开辟另外的内存空间，因为他的内部其实是调用的 __iadd__ 方法，而 __iadd__ 里面又是调用的 extend() 方法。

以上就是关于Go Web 框架 Gin 实践8—为它加上Swagger，帅帅的文档全部的内容，包括:Go Web 框架 Gin 实践8—为它加上Swagger，帅帅的文档、1.FastAPI介绍、SpringBoot使用Swagger2出现Unable to infer base url.等相关内容解答，如果想了解更多相关内容，可以关注我们，你们的支持是我们更新的动力！