在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。了解springcloud架构可以加求求:三五三六二四七二五九。如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。
@RestController @RequestMapping(value="/users") // 通过这里配置使下面的映射都在/users下,可去除 public class UserController { static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); @ApiOperation(value="获取用户列表", notes="") @RequestMapping(value={""}, method=RequestMethod.GET) public List<User> getUserList() { List<User> r = new ArrayList<User>(users.values()); return r; } @ApiOperation(value="创建用户", notes="根据User对象创建用户") @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") @RequestMapping(value="", method=RequestMethod.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}", method=RequestMethod.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}", method=RequestMethod.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}", method=RequestMethod.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的描述信息,如下图所示。
API文档访问与调试
在上图请求的页面中,我们看到user的Value是个输入框?是的,Swagger除了查看接口功能外,还提供了调试测试功能,我们可以点击上图中右侧的Model Schema(黄色区域:它指明了User的数据结构),此时Value中就有了user对象的模板,我们只需要稍适修改,点击下方“Try it out!”按钮,即可完成了一次请求调用!
此时,你也可以通过几个GET请求来验证之前的POST请求是否正确。
相比为这些接口编写文档的工作,我们增加的配置内容是非常少而且精简的,对于原有代码的侵入也在忍受范围之内。因此,在构建RESTful API的同时,加入swagger来对API文档进行管理,是个不错的选择。
相关推荐
- 接口文档引擎:Swagger2 RESTful 风格 API 文档生成 - 全文检索引擎:ElasticSearch - 分布式链路追踪:SkyWalking - 分布式文件系统:Alibaba OSS - 分布式系统网关:Spring Cloud Gateway - 分布式协调系统:...
实验室在线排课系统源码,SpringCloud + Nacos + MyBatis-Plus + MySQL + Redis + EasyExcel + 阿里云 OSS 项目环境: Spring Boot Spring Cloud Nacos Jwt Mybatis-Plus MySQL Redis EasyExcel 阿里云 OSS Swagger-...
Cloud全家桶的分布式微服务C2C模式RESTful风格前后端完全分离的在线家教预约平台 (一) 项目介绍 在线家教预约平台采用C2C运营模式,Spring Cloud作为后端基础开发框架,Vue.js作为前端基础开发框架,以微服务...
* 接口文档引擎:Swagger2 RESTful 风格 API 文档生成 * 全文检索引擎:ElasticSearch (后期考虑加入) * 分布式链路追踪:ZipKin * 分布式文件系统:Alibaba FastDFS * 分布式服务监控:Spring Boot Admin * ...
Zuul、Ribbon、Feign、Turbine、Hystrix、Oauthor2、Sleuth、API Gateway、Spring Cloud、Config Eureka、SSO、Spring Cloud、 BUS、Turbine、Zipkin、Cache、Spring Cloud Admin、API Gateway、ELK Spring Cloud ...
- chapter9-1-2:[Spring Cloud构建微服务架构(二)服务消费者](http://blog.didispace.com/springcloud2/) - chapter9-1-3:[Spring Cloud构建微服务架构(三)断路器](http://blog.didispace.com/springcloud3/) ...
SSM是一种常用的Java开发框架组合,它结合了Spring框架、Spring MVC框架和MyBatis框架的优点,能够快速构建可靠、高效的企业级应用。 1. Spring框架:Spring是一个轻量级的Java开发框架,提供了丰富的功能和模块,...
Spring Boot整合Swagger2构建RESTful API 使用Actuator监控Spring Boot应用 使用Spring Boot发送邮件 使用Spring Boot Admin监控服务 Spring Boot Devtools热部署 Spring Boot logback日志配置 Spring Boot项目打包...
主要技术 SpringBoot:简化新Spring应用的初始搭建以及开发过程 ...Swagger2******/POSTMAN****:Api接口文档工具 MinIO:分布式文件存储类似于OSS,FastDFS 支付宝支付:alipay.com Mysql:关系型数据
chapter3-1-5:使用Swagger2构建RESTful API chapter3-1-6:统一异常处理 chapter3-1-7:使用Java 8中LocalDate等时间日期类的问题解决 chapter3-1-8:扩展XML请求和响应的支持 数据访问 chapter3-2-1:使用...
MyBatis-Plus:持久层框架 Redis:内存缓存 RabbitMQ:消息中间件 HTTPClient: Http协议客户端 Swagger2:Api接口文档工具 Nginx:负载均衡 Lombok Mysql:关系型数据库 MongoDB:面向文档的NoSQL数据库 Java预约...
2基于spring cloud的阿里巴巴的P2P借贷平台(初步服务)开发环境操作系统:Windows 10开发工具:Intellij IDEA...Redis Sentinel消息中间件:RocketMQ接口文档引擎:Swagger2 RESTful风格API文档生成全文检索引擎:Ela
基于Java的微服务实践,单体微服务创建、Docker部署、Dubbo微服务实践等.zip 基于Java的微服务实践。包括Spring Boot开发Web应用、...spring-boot-swagger Spring Boot集成Swagger2 spring-cloud-demo Spring Cloud示例
Swagger2:Api接口文档工具 Nginx:负载均衡 Lombok Mysql:关系型数据库 MongoDB:面向文档的NoSQL数据库 Vue.js:web 界面的渐进式框架 Node.js: JavaScript 运行环境 Axios:Axios 是一个基于 promise 的 ...
实践建造springcloud的maven工程 项目中的技术选型是: 服务注册中心,服务配置: 纳科斯 服务之间的调用: 开放式 服务网关: 网关 用户登录: Spring安全 持久层框架: mybatis-plus 数据库驱动: mybatis-...
目标是基于此项目可以巩固学习spring boot、vue、Mybatis等技术,欢迎star哟~~一、技术架构版本控制:git依赖管理:maven接口文档:Swagger权限验证:Spring Security数据库:MySql、Druid连接池数据访问层:Mybatis...
- Spring Boot 文档生成工具,包括 Swagger、Spring RestDocs - springboot-bussiness - Spring Boot 业务应用,包括 定时任务、上传文件、发送邮件、Doc文档操作 等。 - springboot-ajax - Spring Boot AJAX...
注册中心为nacos SpringBoot整合Mybatis-Plus分页查询+Oracle+Mysql+swagger2
miaosha秒杀商城2代(Spring Cloud版本)项目名称:秒杀商城---- SpringCloud-miaosha由于面临毕业,且时间有限,准备把这个过去的项目使用微服务技术重构一下交上去。持续到2019年9月,会完成全部的更新。附:老...
spring-boot-mybatis spring-boot-dubbo spring-boot-swagger spring-boot-logback spring-boot-elasticsearch spring-boot-elasticsearch-demo spring-boot-lucene-demo Contact 作者:鹏磊 出处: Email:admin@...