首页天道酬勤restful java,spring boot实战

restful java,spring boot实战

张世龙 05-05 21:19 56次浏览

由于Spring Boot具有快速开发、简单部署等特性,因此Spring Boot的大部分用户被认为是用于构建rest风格的API。 另一方面,构建rest风格的API的目的通常是为了共享许多底层业务逻辑的多个终端。 因此,我们将这些层抽象出来,同时为多个移动终端和Web前端提供服务。

这样一来,我们的rest风格的API就可能面临多个开发人员或多个开发团队。 IOS开发、Android开发或Web开发等。 为了降低与其他团队在正常开发过程中的频繁交流成本,传统方法创建了一个rest风格的API文档,以记录所有接口的详细信息,但存在以下问题:

由于接口多、细节复杂,因此需要考虑各种HTTP请求类型、HTTP标头信息、HTTP请求内容等。 高质量地编写本文档本身就很费劲,下游投诉不断。

随着时间的推移,如果不断修改接口实现,则必须同步修改接口文档。 文档和代码位于两个不同的介质上,除非有严格的管理机制,否则容易导致不一致。

为了解决这些问题,本文介绍了rest风格的API的优秀合作伙伴Swagger2,它可以轻松集成到Spring Boot中,并与Spring MVC程序一起创建强大的rest风格的API文档这样可以减少创建文档的工作量,同时将说明内容集成到实现代码中,并将文档维护和代码更改合并到一起。 这样可以在修改代码逻辑的同时轻松更改文档说明。 Swagger2还提供了强大的页面测试功能,用于调试每个rest风格的API。

具体请参考我的swagger文档

添加Swagger2依赖关系将Swagger2依赖关系添加到pom.xml

{% highlight null %}

io.springfox

springfox-swagger2

2.2.2

io.springfox

springfox-swagger-ui

2.2.2

{% endhighlight %}

创建Swagger2的配置类在与Application.java相同的类中创建Swagger2的配置类Swagger2。

{% highlight java %}

package com.xuying.demo;

importorg.spring帧work.context.annotation.bean;

importorg.spring framework.context.annotation.configuration;

importspringfox.documentation.builders.apiinfobuilder;

importspringfox.documentation.builders.path selectors;

importspringfox.documentation.builders.requesthandlerselectors;

importspringfox.documentation.service.API info;

importspringfox.documentation.SPI.documentation type;

importspringfox.documentation.spring.web.plugins.docket;

importspringfox.documentation.swagger2. annotations.enable swagger 2;

@Configuration

@EnableSwagger2

公共类swagger2{

@Bean

公共文档创建器API (

返回新文档(文档类型. swagger _2)。

. APIinfo(APIinfo ) )

. select () )

. APIs (requesthandlerselectors.base package (“com.xuying.demo.web”) )

. paths(pathselectors.any ) )

. build (;

}

隐私API info API info (

返回新apiinfobuilder ()

. title (在spring boot中使用Swagger2构建rest风格的应用程序)

. description (“请关注更多Spring Boot相关文章。 http://jackwolf1.github.io "

. termsofserviceurl (“http://jack wolf1. github.io”)

. contact (“映射”

.版本(“1.0”)

. build (;

}

}

{% endhighlight %}

如上面的代码所示

,通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

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

添加文档内容

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

{% highlight java %}

package com.xuying.demo.web;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

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

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

@RestController
@RequestMapping(value = “/users”) // 通过这里配置使下面的映射都在/users下
public class UserController {

// 创建线程安全的Mapstatic Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());@ApiOperation(value = "获取用户列表", notes = "")@RequestMapping(value = "/", method = RequestMethod.GET)public List<User> getUserList() { // 处理"/users/"的GET请求,用来获取用户列表 // 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递 List<User> r = new ArrayList<User>(users.values()); return r;}@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "query"), @ApiImplicitParam(name = "name", value = "用户名称", required = true, dataType = "String", paramType = "query"), @ApiImplicitParam(name = "age", value = "年龄", required = true, dataType = "Integer", paramType = "query") })@RequestMapping(value = "/", method = RequestMethod.POST)public String postUser(@RequestParam Long id, @RequestParam String name, @RequestParam Integer age) { User user = new User(); user.setId(id); user.setName(name); user.setAge(age); // 处理"/users/"的POST请求,用来创建User // 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数 users.put(user.getId(), user); return "success";}@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path")@RequestMapping(value = "/{id}", method = RequestMethod.GET)public User getUser(@PathVariable Long id) { // 处理"/users/{id}"的GET请求,用来获取url中id值的User信息 // url中的id可通过@PathVariable绑定到函数的参数中 return users.get(id);}@ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path"), @ApiImplicitParam(name = "name", value = "用户名称", required = true, dataType = "String", paramType = "query"), @ApiImplicitParam(name = "age", value = "年龄", required = true, dataType = "Integer", paramType = "query") })@RequestMapping(value = "/{id}", method = RequestMethod.PUT)public String putUser(@PathVariable Long id, @ModelAttribute User user) { // 处理"/users/{id}"的PUT请求,用来更新User信息 User u = users.get(id); u.setName(user.getName()); u.setAge(user.getAge()); users.put(id, u); return "success";}@ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path")@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)public String deleteUser(@PathVariable Long id) { // 处理"/users/{id}"的DELETE请求,用来删除User users.remove(id); return "success";}

}

{% endhighlight %}

@ApiImplicitParam(name = “id”, value = “用户ID”, required = true, dataType = “Long”,paramType = “path”);
paramType = “path”
这个参数直接控制api页面调试时发起的参数的具体类型,是在body、path或者query中

完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html#/
。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求,以POST类型的/users请求为例,可找到上述代码中我们配置的Notes信息以及参数user的描述信息

API文档访问与调试

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

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

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

linux执行jmeter脚本,jmeter脚本用什么语言