临沂百度网站,手机百度下载app,在国外做盗版网站吗,网站开发与设计案例由于Spring Boot能够快速开发、便捷部署等特性#xff0c;相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因#xff0c;这些终端会共用很多底层业务逻辑#xff0c;因此我们会抽象出这样一层来同时服务于多个…由于Spring Boot能够快速开发、便捷部署等特性相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因这些终端会共用很多底层业务逻辑因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。 这样一来我们的RESTful API就有可能要面对多个开发人员或多个开发团队IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本传统做法我们会创建一份RESTful API文档来记录所有接口细节然而这样的做法有以下几个问题 由于接口众多并且细节复杂需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等高质量地创建这份文档本身就是件非常吃力的事下游的抱怨声不绝于耳。随着时间推移不断修改接口实现的时候都必须同步修改接口文档而文档与代码又处于两个不同的媒介除非有严格的管理机制不然很容易导致不一致现象。为了解决上面这样的问题本文将介绍RESTful API的重磅好伙伴Swagger2它可以轻松的整合到Spring Boot中并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量同时说明内容又整合入实现代码中让维护文档和修改代码整合为一体可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示 alt 下面来具体介绍如果在Spring Boot中使用Swagger2。首先我们需要一个Spring Boot实现的RESTful API工程若您没有做过这类内容建议先阅读Spring Boot构建一个较为复杂的RESTful APIs和单元测试。 下面的内容我们会以教程样例中的Chapter3-1-1进行下面的实验Chpater3-1-5是我们的结果工程亦可参考。 添加Swagger2依赖 在pom.xml中加入Swagger2的依赖 1 2 3 4 5 6 7 8 9 10 11 dependency groupIdio.springfox/groupId artifactIdspringfox-swagger2/artifactId version2.2.2/version /dependency dependency groupIdio.springfox/groupId artifactIdspringfox-swagger-ui/artifactId version2.2.2/version /dependency 创建Swagger2配置类 在Application.java同级创建Swagger2的配置类Swagger2。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 Configuration EnableSwagger2 public class Swagger2 { Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage(com.didispace.web)) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title(Spring Boot中使用Swagger2构建RESTful APIs) .description(更多Spring Boot相关文章请关注http://blog.didispace.com/) .termsOfServiceUrl(http://blog.didispace.com/) .contact(程序猿DD) .version(1.0) .build(); } } 如上代码所示通过Configuration注解让Spring来加载该类配置。再通过EnableSwagger2注解来启用Swagger2。 再通过createRestApi函数创建Docket的Bean之后apiInfo()用来创建该Api的基本信息这些基本信息会展现在文档页面中。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现本例采用指定扫描的包路径来定义Swagger会扫描该包下所有Controller定义的API并产生文档内容除了被ApiIgnore指定的请求。 添加文档内容 在完成了上述配置后其实已经可以生产文档内容但是这样的文档主要针对请求本身而描述主要来源于函数等命名产生对用户并不友好我们通常需要自己增加一些说明来丰富文档内容。如下所示我们通过ApiOperation注解来给API增加说明、通过ApiImplicitParams、ApiImplicitParam注解来给参数增加说明。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 RestController RequestMapping(value/users) // 通过这里配置使下面的映射都在/users下可去除 public class UserController { static MapLong, User users Collections.synchronizedMap(new HashMapLong, User()); ApiOperation(value获取用户列表, notes) RequestMapping(value{}, methodRequestMethod.GET) public ListUser getUserList() { ListUser r new ArrayListUser(users.values()); return r; } ApiOperation(value创建用户, notes根据User对象创建用户) ApiImplicitParam(name user, value 用户详细实体user, required true, dataType User) RequestMapping(value, methodRequestMethod.POST) public String postUser(RequestBody User user) { users.put(user.getId(), user); return success; } ApiOperation(value获取用户详细信息, notes根据url的id来获取用户详细信息) ApiImplicitParam(name id, value 用户ID, required true, dataType Long) RequestMapping(value/{id}, methodRequestMethod.GET) public User getUser(PathVariable Long id) { return users.get(id); } ApiOperation(value更新用户详细信息, notes根据url的id来指定更新对象并根据传过来的user信息来更新用户详细信息) ApiImplicitParams({ ApiImplicitParam(name id, value 用户ID, required true, dataType Long), ApiImplicitParam(name user, value 用户详细实体user, required true, dataType User) }) RequestMapping(value/{id}, methodRequestMethod.PUT) 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; } ApiOperation(value删除用户, notes根据url的id来指定删除对象) ApiImplicitParam(name id, value 用户ID, required true, dataType Long) RequestMapping(value/{id}, methodRequestMethod.DELETE) public String deleteUser(PathVariable Long id) { users.remove(id); return success; } } 完成上述代码添加上启动Spring Boot程序访问http://localhost:8080/swagger-ui.html。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求以POST类型的/users请求为例可找到上述代码中我们配置的Notes信息以及参数user的描述信息如下图所示。 alt API文档访问与调试 在上图请求的页面中我们看到user的Value是个输入框是的Swagger除了查看接口功能外还提供了调试测试功能我们可以点击上图中右侧的Model Schema黄色区域它指明了User的数据结构此时Value中就有了user对象的模板我们只需要稍适修改点击下方“Try it out”按钮即可完成了一次请求调用 此时你也可以通过几个GET请求来验证之前的POST请求是否正确。 相比为这些接口编写文档的工作我们增加的配置内容是非常少而且精简的对于原有代码的侵入也在忍受范围之内。因此在构建RESTful API的同时加入swagger来对API文档进行管理是个不错的选择。转载于:https://www.cnblogs.com/xiangjune/p/6639832.html
