Linux Swagger如何实现API文档自动生成

在Linux环境下，Swagger（现更名为OpenAPI Specification）可以通过自动扫描项目中的API接口并生成包含接口名称、描述、请求参数、响应数据等信息的文档，从而实现API文档的自动生成。以下是使用Swagger在Linux中实现API文档自动生成的步骤：

使用go swag生成Swagger文档

1. 安装go swag：

   在终端中运行以下命令来安装go swag工具：

   go get -u github.com/swaggo/swag/cmd/swag
   

2. 编写API注释：

   在您的Go代码中，使用go swag注释来描述API接口。例如：

   // @Summary 创建管理员
   // @Description 创建管理员
   // @Tags api.admin
   // @Accept  application/x-www-form-urlencoded
   // @Produce  json
   // @Param username formdata string true "用户名"
   // @Param mobile formdata string true "手机号"
   // @Success 200 {object} createresponse
   // @Failure 400 {object} code.failure
   // @Router /api/admin [post]
   

3. 生成Swagger文档：

   在代码所在目录下运行以下命令来生成Swagger文档：

   swag init
   

   这将在项目目录下生成一个docs文件夹，其中包含生成的Swagger文档。

4. 访问Swagger UI：

   启动您的应用程序后，可以通过以下URL访问Swagger UI：

   http://localhost:9999/swagger/index.html
   

   如果您的应用程序配置了安全参数，可能需要根据配置调整访问权限。

使用Springfox生成Swagger文档

如果您使用的是Spring Boot项目，可以通过添加Springfox依赖来自动生成Swagger文档。

1. 添加Springfox依赖：

   在pom.xml文件中添加以下依赖：

   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
   </dependency>
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
   </dependency>
   

2. 配置Swagger：

   创建一个Swagger配置类，例如：

   import springfox.documentation.builders.PathSelectors;
   import springfox.documentation.builders.RequestHandlerSelectors;
   import springfox.documentation.spi.DocumentationType;
   import springfox.documentation.spring.web.plugins.Docket;
   import springfox.documentation.swagger2.annotations.EnableSwagger2;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   @EnableSwagger2
   public class SwaggerConfig {
       @Bean
       public Docket api() {
           return new Docket(DocumentationType.SWAGGER_2)
                   .select()
                   .apis(RequestHandlerSelectors.basePackage("com.example.yourpackage"))
                   .paths(PathSelectors.any())
                   .build();
       }
   }
   

3. 访问Swagger UI：

   启动Spring Boot应用程序后，可以通过以下URL访问Swagger UI：

   http://localhost:8080/swagger-ui.html
   

通过上述步骤，您可以在Linux环境下使用Swagger自动生成API文档，从而提高开发效率和文档质量。