关闭

springboot【5】web开发之Swagger2

标签: springboot教程springbootspringspringboot入门Swagger2
333人阅读 评论(0) 收藏 举报
分类:

在做接口模块时,往往是分离开发,在各部门沟通时往往会定接口和测试。

传统做法:我们会创建一份RESTful API文档来记录所有接口细节,然而这样的做法有以下几个问题:

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

springboot做法:使用Swagger2构建强大的RESTful API文档。Swagger2可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量,同时说明内容又整合入实现代码中,让维护文档和修改代码整合为一体,可以让我们在修改代码逻辑的同时方便的修改文档说明,所以加入swagger来对API文档进行管理,是个不错的选择。。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示:



在Spring Boot中使用Swagger2。首先,我们需要一个Spring Boot实现的RESTful API工程。

下面的内容我们会以【3】springboot开发web之构建RESTful API与单元测试中的example03进行下面的功能测试。

1.添加Swagger2依赖

pom.xml中加入Swagger2的依赖

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

2.创建Swagger2配置类

Application.java同级创建Swagger2的配置类Swagger2.java

package com.lyd;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 
 * <p>Title: Swagger2.java</p>
 * <p>Description: </p>
 * @author lyd
 * @date 2017年7月30日
 * @version 1.0
 * @blog springboot学习http://blog.csdn.net/IT_lyd/article/category/6692929
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

	@Bean
	public Docket createRestApi(){
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.lyd.web"))
				.paths(PathSelectors.any())
				.build();
	}
	
	private ApiInfo apiInfo(){
		return new ApiInfoBuilder()
				.title("Spring Boot中使用Swagger2构建RESTful APIs")
				.description("springboot个人学习:http://blog.csdn.net/IT_lyd/article/category/6692929")
				.termsOfServiceUrl("http://blog.csdn.net/IT_lyd/article/category/6692929")
				.contact("lyd")
				.version("1.0")
				.build();
	}
	
}

上面代码含义解释:通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

再通过createRestApi函数创建Docket的Bean之后,apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描的包路径来定义,Swagger会扫描该包下所有Controller定义的API,并产生文档内容(除了被@ApiIgnore指定的请求)。


3.添加文档内容

在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,用户体验并不友好,我们通常需要自己增加一些说明来丰富文档内容。如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams@ApiImplicitParam注解来给参数增加说明。

package com.lyd.web;

import java.util.*;

import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.lyd.entity.User;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

/**
 * 
 * <p>Title: UserController.java</p>
 * <p>Description: </p>
 * <p>Copyright: Copyright (c) 2017</p>
 * @author lyd
 * @date 2017年7月27日
 * @version 1.0
 */
@RestController
@RequestMapping(value="/users")
public class UserController {

	//创建线程安全的map
	static Map<Long, User> users =  Collections.synchronizedMap(new HashMap<Long, User>());
	
	/*
	 * 处理"/users/"的GET请求,用来获取用户列表
	 * 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
	 */
	@ApiOperation(value="获取用户列表", notes="")
	@RequestMapping(value="/", method=RequestMethod.GET)
	public List<User> getUserList(){
		List<User> u = new ArrayList<User>(users.values());
		return u;
	}
	
	/*
	 * 处理"/users/"的POST请求,用来创建User
	 * 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数
	 */
	@ApiOperation(value="创建用户", notes="根据user对象创建用户")
	@ApiImplicitParam(name="user", value="用户实体User", required=true, dataType="User" )
    @RequestMapping(value="/", method=RequestMethod.POST)
    public String postUser(@ModelAttribute User user) {
        users.put(user.getId(), user);
        return "success";
    }

    /*
     * 处理"/users/{id}"的GET请求,用来获取url中id值的User信息
     * url中的id可通过@PathVariable绑定到函数的参数中
     */
	@ApiOperation(value="获取用户详情", notes="根据url汇总id值获取用户详情")
	@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return users.get(id);
    }

    /*
     * 处理"/users/{id}"的PUT请求,用来更新User信息
     */
	@ApiOperation(value="更新用户信息", notes="根据url的id值更新用户信息")
	@ApiImplicitParams({
		@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long"),
		@ApiImplicitParam(name="user", value="用户实体User", required=true, dataType="User" )
	})
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @ModelAttribute User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }

    /*
     * 处理"/users/{id}"的DELETE请求,用来删除User
     */
	@ApiOperation(value="删除用户", notes="根据url的id值删除user对象")
	@ApiImplicitParam(name="id", value="用户ID", required=true, dataType="Long")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        users.remove(id);
        return "success";
    }
}

4.启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html

就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求,以POST类型的/users请求为例,可找到上述代码中我们配置的Notes信息以及参数user的描述信息,如下图所示。


API文档访问与调试

Swagger除了查看接口功能外,还提供了调试测试功能,我们可以点击上图中右侧的Model Schema(黄色区域:它指明了User的数据结构),此时Value中就有了user对象的模板,我们只需要稍适修改,点击下方“Try it out!”按钮,即可完成了一次请求调用!

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


下面是完整项目结构:




1
0
查看评论
发表评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场

SpringBoot开发详解(八) -- 使用Swagger2构建API文档

API文档文档在开发中的价值与作用:作为一个开发人员,平时看得最多的恐怕就是各式各样的文档了。并且在开发中我们也避免不了的需要自己去书写文档,比如作为后台开发人员,我们书写最多的应该就是接口文档了。前...
  • qq_31001665
  • qq_31001665
  • 2017-05-21 23:13
  • 614

SpringBoot非官方教程 | 第十一篇:springboot集成swagger2,构建优雅的Restful API

swagger,中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅...
  • forezp
  • forezp
  • 2017-04-30 16:13
  • 29686

Spring Boot学习笔记 - 整合Swagger2自动生成RESTful API文档

在App后端开发中经常需要对移动客户端(Android、iOS)提供RESTful API接口,在后期版本快速迭代的过程中,修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,...
  • FX_SKY
  • FX_SKY
  • 2017-01-04 19:28
  • 5431

Swagger(一) SpringBoot整合Swagger2简单的例子

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成...
  • u010919351
  • u010919351
  • 2017-04-11 19:12
  • 7307

SpringBoot集成Swagger2中遇到的问题

原文:http://www.jianshu.com/p/840320d431a1 参考: http://www.jianshu.com/p/8033ef83a8ed ...
  • keplerpig
  • keplerpig
  • 2017-11-22 11:39
  • 390

springboot学习一,web实例

springboot学习一, spring boot实例
  • zhaozhenzuo
  • zhaozhenzuo
  • 2016-10-12 07:45
  • 1015

解决Spring boot中使用Gson,Swagger2 api-docs无法正常显示json问题

解决Spring boot中使用Gson,Swagger2 api-docs无法正常显示json问题
  • u012607848
  • u012607848
  • 2017-03-09 20:07
  • 3291

springboot - 一个最简单的Web应用

原文:http://blog.csdn.net/xiaoyu411502/article/details/47864969 一个最简单的Web应用 使用Spring Boot框架可以大大加...
  • lan861698789
  • lan861698789
  • 2016-09-13 00:24
  • 524

使用Spring Boot开发Web项目

前面两篇博客中我们简单介绍了Spring Boot项目的创建、并且也带小伙伴们来DIY了一个Spring Boot自动配置功能,那么这些东西说到底最终还是要回归到Web上才能体现出它的更大的价值,so...
  • u012702547
  • u012702547
  • 2016-12-21 17:26
  • 61755

HTML5移动web开发指南笔记

手机内置浏览器:  Android:Andriod BrowserIOS:Mobile SafariBlackBerry:WebkitSymbian S60: Web Browser f...
  • herion_liu
  • herion_liu
  • 2016-06-07 16:01
  • 1336
    个人资料
    • 访问:103084次
    • 积分:1798
    • 等级:
    • 排名:千里之外
    • 原创:87篇
    • 转载:5篇
    • 译文:0篇
    • 评论:15条
    在线服务
      进入我的网站

      关注我的微博

      QQ与我联系
    博客专栏