swagger and restful api 参考
http://git.oschina.net/redArmy/spring-cloud-books/blob/master/spring-cloud-provider-book/src/main/java/com/wujunshen/controller/BookController.java /*** @param book 传入的book对象实例* @return 成功或失败信息,json格式封装*/@PostMapping(value = "/api/books", consumes = MediaType.APPLICATION_JSON_UTF8_VALUE, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)@ApiOperation(value = "添加某本书籍", httpMethod = "POST",notes = "添加成功返回bookId",response = BaseResultVo.class)@ApiResponses(value = {@ApiResponse(code = 200, message = "Success", response = BaseResultVo.class),@ApiResponse(code = 401, message = "Unauthorized"),@ApiResponse(code = 403, message = "Forbidden"),@ApiResponse(code = 404, message = "Not Found"),@ApiResponse(code = 500, message = "Failure")})public BaseResultVo saveBook(@Validated @ApiParam(value = "添加的某本书籍信息", required = true) @RequestBody Book book) {BaseResultVo baseResultVo = new BaseResultVo();baseResultVo.setData(bookService.saveBook(book));baseResultVo.setCode(ResultStatusCode.OK.getCode());baseResultVo.setMessage(ResultStatusCode.OK.getMessage());return baseResultVo;}/*** @return 成功或失败信息,json格式封装*/@GetMapping(value = "/api/books", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)@ApiOperation(value = "查询所有书籍", httpMethod = "GET",notes = "查询所有书籍",response = BaseResultVo.class)@ApiResponses(value = {@ApiResponse(code = 200, message = "Success", response = BaseResultVo.class),@ApiResponse(code = 401, message = "Unauthorized"),@ApiResponse(code = 403, message = "Forbidden"),@ApiResponse(code = 404, message = "Not Found"),@ApiResponse(code = 500, message = "Failure")})public BaseResultVo getBooks() {Books books = bookService.getBooks();BaseResultVo baseResultVo = new BaseResultVo();if ((books != null) && (!books.getBookList().isEmpty())) {baseResultVo.setData(books);baseResultVo.setCode(ResultStatusCode.OK.getCode());baseResultVo.setMessage(ResultStatusCode.OK.getMessage());} else {baseResultVo.setCode(ResultStatusCode.DATA_QUERY_ERROR.getCode());baseResultVo.setData("Query books failed");baseResultVo.setMessage(ResultStatusCode.DATA_QUERY_ERROR.getMessage());}return baseResultVo;}/*** @param bookId 传入的bookId* @return 成功或失败信息,json格式封装*/@GetMapping(value = "/api/books/{bookId:[0-9]*}")@ApiOperation(value = "查询某本书籍", httpMethod = "GET",notes = "根据bookId,查询到某本书籍",response = BaseResultVo.class)@ApiResponses(value = {@ApiResponse(code = 200, message = "Success", response = BaseResultVo.class),@ApiResponse(code = 401, message = "Unauthorized"),@ApiResponse(code = 403, message = "Forbidden"),@ApiResponse(code = 404, message = "Not Found"),@ApiResponse(code = 500, message = "Failure")})public BaseResultVo getBook(@ApiParam(value = "书籍ID", required = true) @PathVariable("bookId") Integer bookId) {LOGGER.info("请求参数bookId值:{}", bookId);Book book = bookService.getBook(bookId);BaseResultVo baseResultVo = new BaseResultVo();if (book != null) {LOGGER.info("查询到书籍ID为{}的书籍", bookId);baseResultVo.setData(book);baseResultVo.setCode(ResultStatusCode.OK.getCode());baseResultVo.setMessage(ResultStatusCode.OK.getMessage());} else {LOGGER.info("没有查询到书籍ID为{}的书籍", bookId);baseResultVo.setCode(ResultStatusCode.DATA_QUERY_ERROR.getCode());baseResultVo.setData("Query book failed id=" + bookId);baseResultVo.setMessage(ResultStatusCode.DATA_QUERY_ERROR.getMessage());}return baseResultVo;}@PutMapping(value = "/api/books/{bookId:[0-9]*}")@ApiOperation(value = "更新某本书籍", httpMethod = "PUT",notes = "更新的某本书籍信息",response = BaseResultVo.class)@ApiResponses(value = {@ApiResponse(code = 200, message = "Success", response = BaseResultVo.class),@ApiResponse(code = 401, message = "Unauthorized"),@ApiResponse(code = 403, message = "Forbidden"),@ApiResponse(code = 404, message = "Not Found"),@ApiResponse(code = 500, message = "Failure")})public BaseResultVo updateBook(@NotNull @ApiParam(value = "要更新的某本书籍ID", required = true) @PathVariable("bookId") Integer bookId, @Validated @NotNull @ApiParam(value = "要更新的某本书籍信息", required = true) @RequestBody Book book) {LOGGER.info("请求参数bookId值:{}", bookId);BaseResultVo baseResultVo = new BaseResultVo();if (bookId == null && book == null) {baseResultVo.setCode(ResultStatusCode.DATA_INPUT_ERROR.getCode());baseResultVo.setMessage(ResultStatusCode.DATA_INPUT_ERROR.getMessage());return baseResultVo;}if (bookService.getBook(bookId) == null) {baseResultVo.setCode(ResultStatusCode.DATA_QUERY_ERROR.getCode());baseResultVo.setData("book id=" + bookId + " not existed");baseResultVo.setMessage(ResultStatusCode.DATA_QUERY_ERROR.getMessage());return baseResultVo;}Book updatedBook = bookService.updateBook(book);if (updatedBook != null) {baseResultVo.setData(updatedBook);baseResultVo.setCode(ResultStatusCode.OK.getCode());baseResultVo.setMessage(ResultStatusCode.OK.getMessage());} else {baseResultVo.setCode(ResultStatusCode.DATA_UPDATED_ERROR.getCode());baseResultVo.setData("Update book failed id=" + book.getBookId());baseResultVo.setMessage(ResultStatusCode.DATA_UPDATED_ERROR.getMessage());}return baseResultVo;}@DeleteMapping(value = "/api/books/{bookId:[0-9]*}")@ApiOperation(value = "删除某本书籍信息", httpMethod = "DELETE",notes = "删除某本书籍信息",response = BaseResultVo.class)@ApiResponses(value = {@ApiResponse(code = 200, message = "Success", response = BaseResultVo.class),@ApiResponse(code = 401, message = "Unauthorized"),@ApiResponse(code = 403, message = "Forbidden"),@ApiResponse(code = 404, message = "Not Found"),@ApiResponse(code = 500, message = "Failure")})public BaseResultVo deleteBook(@ApiParam(value = "要删除的某本书籍ID", required = true) @PathVariable("bookId") Integer bookId) {BaseResultVo baseResultVo = new BaseResultVo();if (bookService.deleteBook(bookId) == 1) {baseResultVo.setData("Deleted book id=" + bookId);baseResultVo.setCode(ResultStatusCode.OK.getCode());baseResultVo.setMessage(ResultStatusCode.OK.getMessage());} else {baseResultVo.setCode(ResultStatusCode.DATA_DELETED_ERROR.getCode());baseResultVo.setData("Deleted book failed id=" + bookId);baseResultVo.setMessage(ResultStatusCode.DATA_DELETED_ERROR.getMessage());}return baseResultVo;}
swagger and restful api 参考的更多相关文章
- Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档 简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...
- 使用swagger作为restful api的doc文档生成
初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份 ...
- 使用swagger作为restful api的doc文档生成——从源码中去提取restful URL接口描述文档
初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份 ...
- 基于jeesite的cms系统(三):使用RESTful API在前端渲染数据
使用RESTful API可以更好的开发前后分离的应用,后面一节会介绍使用模版引擎Beetl开发后端渲染的应用. 一.配置Swagger(Api 接口文档) 1.使用系统自带 拷贝jeesite-mo ...
- Yii2 Restful API 原理分析
Yii2 有个很重要的特性是对 Restful API的默认支持, 通过短短的几个配置就可以实现简单的对现有Model的RESTful API 参考另一篇文章: http://www.cnblogs. ...
- Yii2+Swagger搭建RESTful风格的API项目
在现有的Advanced Template上搭建RESTful API项目的步骤: 本案例前提说明: 本例中不使用\yii\rest\ActiveController自动创建的API,而是自定义一个A ...
- ****RESTful API 设计最佳实践(APP后端API设计参考典范)
http://blog.jobbole.com/41233/ 背景 目前互联网上充斥着大量的关于RESTful API(为方便,下文中“RESTful API ”简写为“API”)如何设计的文章,然而 ...
- spring boot之使用springfox swagger展示restful的api doc
摘要 springfox swagger展示restful的api doc, swagger is A POWERFUL INTERFACE TO YOUR API. 新增文件: import org ...
- 使用swagger 生成 Flask RESTful API
使用swagger 生成 Flask RESTful API http://www.voidcn.com/article/p-rcvzjvpf-e.html swagger官网 https://swa ...
随机推荐
- Spark RDD关联操作小结
前言 Spark的rdd之间的关系需要通过一些特定的操作来实现, 操作比较多也,特别是一堆JOIN也挺容易让人产生混乱的. 因此做了下小结梳理一下. 准备数据 var rdd1 = sc.makeRD ...
- THINKPHP URL模块大小写导致404问题
最近我使用THINKPHP开发了一个项目在本地的集成开发环境wampserver做开发时并没有出现问题 上传到linux系统也没有出现问题,但当上传到windows平台上就出现了问题"文件4 ...
- SSIS包部署错误之运行环境设置
在SQLServer代理处新建了一个job,步骤里面的操作是指向一个SSIS模型包 执行,报错如下 根据报错信息是64bit,于是做出修改如下图 再次执行 OK
- 利用vbs设置Java环境变量
每次PC重装后,又要设定Java环境变量,向我这种不爱记得人,老是要去找设定内容 感觉设置环境变量还真是比较麻烦,我是希望可以做成点击一下就ok的,这样重装系统就不用那么麻烦了, 但是考虑到通用性,为 ...
- (队列的应用5.3.2)POJ 2259 Team Queue(队列数组的使用)
/* * POJ_2259.cpp * * Created on: 2013年10月30日 * Author: Administrator */ #include <iostream> # ...
- hdu4497 GCD and LCM
GCD and LCM Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 65535/65535 K (Java/Others) Total S ...
- alias的使用
alias,即别名.可以通过较短的别名,来实现对应的真实的命令.将alias定义在.bash_profile文件中,即可在任意目录下执行自己定义的这些命令了. 1. 命令 alias myDir='c ...
- ThinkPHP的A方法,R方法,M方法,D方法区别
在Thinkphp中,实例化对象有这么几种方法,如果是类,有A和R方法,区别是A方法只是对象的实例化,而R方法是可以同时实例化对象里面的方法的,这里需要去指定,如下面的实例代码: <?php n ...
- Servlet介绍(一)
Servlet介绍(一) Servlet是一个执行在webserver上的小的Java程序,它通过接收和响应webclient的请求.在tomcatserver中有已经帮我们实现好了Servlet接口 ...
- IOS版微信小视频导出方法
1.在电脑上连接手机,打开iTools 选择 应用-应用-文件共享. 2.依次打开/Library/WechatPrivate/6e2809aac61608de6a6cc55d9570d25b/Sig ...