你是不是曾为在Debian云服务器上编写Swagger文档而烦恼？是不是觉得效率矮小下文档质量不高大？别担心，今天就来给你揭秘高大效编写Swagger文档的秘诀。

一、 周围搭建：稳扎稳打的基础

在Debian云服务器上，先说说需要搭建一个稳稳当当的周围。

命令	说明
sudo apt update	更新鲜系统柔软件包列表
sudo apt install openjdk-11-jdk	安装Java开发周围
java -version	检查Java版本
mvn -version	检查Maven版本

二、 依赖安装：如虎添翼的利器

在Spring Boot项目中，我们需要添加Swagger相关的依赖。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api {
        return new Docket
                .select
                .apis)
                .paths)
                .build;
    }
}

三、 配置Spring Boot：让Swagger飞起来

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api {
        return new Docket
                .select
                .apis)
                .paths)
                .build;
    }
}

四、 用Swagger注解：让文档更详细

为了使API文档更加详细和清晰，我们能用Swagger给的注解。

• @ApiOperation用于说说API操作
• @ApiParam用于说说API参数
• @ApiResponse用于说说API响应

五、生成和访问文档：一触即发

用Swagger工具根据API定义文件自动生成文档。

mvn clean install

启动Spring Boot应用后 在浏览器中访问以下URL查看Swagger生成的API文档：

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

六、高大效编写Swagger文档的秘诀

和访问文档，这些个步骤缺一不可。只有掌握了这些个秘诀，你才能在Debian云服务器上轻巧松地编写高大质量的Swagger文档。

本文来源于《Debian云服务器高大效编写Swagger文档指南》， 作者：云服务器细小助手，时候：2021年9月。

---