计算机系统应用教程网站

网站首页 > 技术文章 正文

Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档

btikc 2024-09-14 00:43:40 技术文章 7 ℃ 0 评论

随着前后端分离架构和微服务架构的流行，我们使用Spring Boot来构建RESTful API项目的场景越来越多。通常我们的一个RESTful API就有可能要服务于多个不同的开发人员或开发团队：IOS开发、Android开发、Web开发甚至其他的后端服务等。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法就是创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：

  • 由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。
  • 随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。

为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：

下面来具体介绍，在Spring Boot中使用我们自己实现的starter来整合Swagger。该整合项目的Github：https://github.com/SpringForAll/spring-boot-starter-swagger。如果您觉得它好用，欢迎Star支持我们！

准备工作

首先，我们需要一个Spring Boot实现的RESTful API工程，若您没有做过这类内容，建议先阅读上一篇教程：http://blog.didispace.com/spring-boot-learning-21-2-1/构建一个。或者也可以直接使用上一篇教程中的样例作为基础，即下面仓库中的chapter2-1工程：

  • Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x
  • Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

整合Swagger2

下面，我们以上面仓库中的chapter2-1工程进行整合改造。

第一步：添加swagger-spring-boot-starter依赖

在pom.xml中加入依赖，具体如下：

<dependency>
 <groupId>com.spring4all</groupId>
 <artifactId>swagger-spring-boot-starter</artifactId>
 <version>1.9.0.RELEASE</version>
</dependency>

第二步：应用主类中添加@EnableSwagger2Doc注解，具体如下

@EnableSwagger2Doc
@SpringBootApplication
public class Chapter22Application {
 public static void main(String[] args) {
 SpringApplication.run(Chapter22Application.class, args);
 }
}

第三步：application.properties中配置文档相关内容，比如

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.x
swagger.version=1.4.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=didi
swagger.contact.url=http://blog.didispace.com
swagger.contact.email=dyc87112@qq.com
swagger.base-package=com.didispace
swagger.base-path=/**

各参数配置含义如下：

  • swagger.title：标题
  • swagger.description：描述
  • swagger.version：版本
  • swagger.license：许可证
  • swagger.licenseUrl：许可证URL
  • swagger.termsOfServiceUrl：服务条款URL
  • swagger.contact.name：维护人
  • swagger.contact.url：维护人URL
  • swagger.contact.email：维护人email
  • swagger.base-package：swagger扫描的基础包，默认：全扫描
  • swagger.base-path：需要处理的基础URL规则，默认：/**

更多配置说明可见官方说明：https://github.com/SpringForAll/spring-boot-starter-swagger

第四步：启动应用，访问：http://localhost:8080/swagger-ui.html，就可以看到如下的接口文档页面：

添加文档内容

在整合完Swagger之后，在http://localhost:8080/swagger-ui.html页面中可以看到，关于各个接口的描述还都是英文或遵循代码定义的名称产生的。这些内容对用户并不友好，所以我们需要自己增加一些说明来丰富文档内容。如下所示，我们通过@Api，@ApiOperation注解来给API增加说明、通过@ApiImplicitParam、@ApiModel、@ApiModelProperty注解来给参数增加说明。

比如下面的例子：

@Api(tags = "用户管理")
@RestController
@RequestMapping(value = "/users") // 通过这里配置使下面的映射都在/users下
public class UserController {
 // 创建线程安全的Map，模拟users信息的存储
 static Map<Long, User> users = Collections.synchronizedMap(new HashMap<>());
 @GetMapping("/")
 @ApiOperation(value = "获取用户列表")
 public List<User> getUserList() {
 List<User> r = new ArrayList<>(users.values());
 return r;
 }
 @PostMapping("/")
 @ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
 public String postUser(@RequestBody User user) {
 users.put(user.getId(), user);
 return "success";
 }
 @GetMapping("/{id}")
 @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")
 public User getUser(@PathVariable Long id) {
 return users.get(id);
 }
 @PutMapping("/{id}")
 @ApiImplicitParam(paramType = "path", dataType = "Long", name = "id", value = "用户编号", required = true, example = "1")
 @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
 public String putUser(@PathVariable Long id, @RequestBody User user) {
 User u = users.get(id);
 u.setName(user.getName());
 u.setAge(user.getAge());
 users.put(id, u);
 return "success";
 }
 @DeleteMapping("/{id}")
 @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")
 public String deleteUser(@PathVariable Long id) {
 users.remove(id);
 return "success";
 }
}
@Data
@ApiModel(description="用户实体")
public class User {
 @ApiModelProperty("用户编号")
 private Long id;
 @ApiModelProperty("用户姓名")
 private String name;
 @ApiModelProperty("用户年龄")
 private Integer age;
}

完成上述代码添加后，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html，就能看到下面这样带中文说明的文档了（其中标出了各个注解与文档元素的对应关系以供参考）：

API文档访问与调试

在上图请求的页面中，我们看到user的Value是个输入框？是的，Swagger除了查看接口功能外，还提供了调试测试功能，我们可以点击上图中右侧的Model Schema（黄色区域：它指明了User的数据结构），此时Value中就有了user对象的模板，我们只需要稍适修改，点击下方“Try it out！”按钮，即可完成了一次请求调用！

此时，你也可以通过几个GET请求来验证之前的POST请求是否正确。

相比为这些接口编写文档的工作，我们增加的配置内容是非常少而且精简的，对于原有代码的侵入也在忍受范围之内。因此，在构建RESTful API的同时，加入Swagger来对API文档进行管理，是个不错的选择。

代码示例

本文的完整工程可以查看下面仓库中的chapter2-2目录：

  • Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x
  • Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

如果您觉得本文不错，欢迎Star支持，您的关注是我坚持的动力！

来源：http://blog.didispace.com/spring-boot-learning-21-2-2/

Tags：

猜你喜欢

本文暂时没有评论，来添加一个吧(●'◡'●)

欢迎 你 发表评论:

最近发表
标签列表