900字范文 > SpringBoot整合Swagger 自动生成API文档偷懒必备同时也是我们的基本操作啦！！！

SpringBoot整合Swagger 自动生成API文档偷懒必备同时也是我们的基本操作啦！！！

时间：2020-11-13 02:36:48

不知道哦昨天的七夕过的咋样，总之我就是在这new GirlFriend()、在那netw GirlFriend()，就这样度过了一天。😐😶
现在大都数项目都已是前后端分离的啦，那么接口文档就成了项目中非常重要的一部分啦，SpringBoot整合Swagger可以自动生成RESTFUL风格的API文档，也可以在其中进行测试，比起以前手写的文档，不仅方便很多，而且也易于修改和测试。
很喜欢一句话：”八小时内谋生活，八小时外谋发展“
我们："待别日相见时，都已有所成”😁

好的天气，好的心情

SpringBoot整合Swagger 自动生成在线API文档

一、前言1）引入2）介绍3）作用二、快速开始2.1、步骤：2.2、导入依赖：2.3、yml配置文件2.4、SwaggerConfig配置类2.4、实体类2.5、Service层2.6、Controller三、测试初始信息：接口：测试：四、Swagger VS PostMan五、自言自语

一、前言

1）引入

现在小伙伴学习SpringBoot大都数是前后端开发的，这个API接口文档真的不可缺少的一部分。

我们开发好项目–>启动–>测试–>前端查看API文档–>数据渲染。用Swagger可以不用写自己写了，可以直接在代码中声明，非常方便，也易于更改。

我这个东东可以直接CV哈，没啥特殊的，直接可以跑起来滴。😁😁😁

2）介绍

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。

3）作用

将项目中所有的接口展现在页面上，这样后端程序员就不需要专门为前端使用者编写专门的接口文档；当接口更新之后，只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了，从而规避了接口文档老旧不能使用的问题；通过 Swagger 页面，我们可以直接进行接口调用，降低了项目开发阶段的调试成本。

二、快速开始

案例：

写一个RESTFUL风格的增删改查哈，然后展示接口哈。

2.1、步骤：

新建一个SpringBoot项目导入依赖书写配置编码启动测试 -->完事👨‍💻（继续摸鱼）

2.2、导入依赖：

<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.3、yml配置文件

server:port: 8088spring:application:name: springboot-swaggerswagger:enable: true

2.4、SwaggerConfig配置类

import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.core.env.Environment;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList;/*** @version 1.0* @author： crush* @date： -12-01 10:48* @EnableSwagger2 启动使用Swagger2*/@Configuration@EnableSwagger2public class SwaggerConfig {// 通过配置文件中这个变量的值来开启或关闭@Value("${swagger.enable}")private Boolean enable;@Beanpublic Docket docket(Environment environment) {return new Docket(DocumentationType.SWAGGER_2).enable(enable).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.crush.swagger")).build();}public ApiInfo apiInfo() {// 这里是作者信息及文档的基本信息和页面展示信息一一对照即可 Contact contact = new Contact("springboot-swagger ", "/weixin_45821811?spm=1011.2124.3001.5343", "951930136@");return new ApiInfo("springboot-swagger Demo API接口文档","此处填写描述信息","1.0","urn:tos",contact,"Apache 2.0","/licenses/LICENSE-2.0",new ArrayList());}}

2.4、实体类

@Data@Accessors(chain = true)@ApiModel(description = "账户相关信息类")public class Account {@ApiModelProperty("账号")private String username;@ApiModelProperty("密码")private String password;}

2.5、Service层

public interface AccountService {/*** 注册* @param account* @return*/boolean register(Account account);/*** 查询全部*/List<Account> select(); }

impl:我此处只是用了静态变量模拟了一下~~（太懒啦捂脸）~~

@Servicepublic class AccountServiceImpl implements AccountService {private static List<Account> accountList = new ArrayList<Account>();@Overridepublic boolean register(Account account) {accountList.add(account);return true;}@Overridepublic List<Account> select() {return accountList;}}

2.6、Controller

@Api(tags = "账户相关接口")@RestController@RequestMapping("/account")public class AccountController {private final AccountService accountService;public AccountController(AccountService accountService) {this.accountService = accountService;}@ApiOperation("注册接口")@PostMapping("/register")public String register(@RequestBody @ApiParam(required = true, value = "注册账户需要的信息") Account account) {accountService.register(account);return "OK";}@ApiOperation("查询全部")@GetMappingpublic List<Account> select() {return accountService.select();}}

启动类就是普普通通的没啥特殊的，让我们直接开始吧。

@Slf4j@SpringBootApplicationpublic class SpringBootSwagger {public static void main(String[] args) {SpringApplication.run(SpringBootSwagger.class);log.info("API接口访问链接:http://localhost:8088/swagger-ui.html");}}