swagger注释API详细说明
来源:互联网 发布:java synchronization 编辑:程序博客网 时间:2024/05/17 17:41
API详细说明
注释汇总
@RequestMapping此注解的推荐配置
value
method
produces
示例:
@ApiOperation("信息软删除") @ApiResponses({ @ApiResponse(code = CommonStatus.OK, message = "操作成功"), @ApiResponse(code = CommonStatus.EXCEPTION, message = "服务器内部异常"), @ApiResponse(code = CommonStatus.FORBIDDEN, message = "权限不足") }) @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", dataType = "Long", name = "id", value = "信息id", required = true) }) @RequestMapping(value = "/remove.json", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE) public RestfulProtocol remove(Long id) {
@ApiModelProperty(value = "标题") private String title;
@ApiImplicitParam
paramType 示例详解
path
@RequestMapping(value = "/findById1/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE) @PathVariable(name = "id") Long id
body
@ApiImplicitParams({ @ApiImplicitParam(paramType = "body", dataType = "MessageParam", name = "param", value = "信息参数", required = true) }) @RequestMapping(value = "/findById3", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE) @RequestBody MessageParam param 提交的参数是这个对象的一个json,然后会自动解析到对应的字段上去,也可以通过流的形式接收当前的请求数据,但是这个和上面的接收方式仅能使用一个(用@RequestBody之后流就会关闭了)
header
@ApiImplicitParams({ @ApiImplicitParam(paramType = "header", dataType = "Long", name = "id", value = "信息id", required = true) }) String idstr = request.getHeader("id"); if (StringUtils.isNumeric(idstr)) { id = Long.parseLong(idstr); }
Form
@ApiImplicitParams({ @ApiImplicitParam(paramType = "form", dataType = "Long", name = "id", value = "信息id", required = true) }) @RequestMapping(value = "/findById5", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE, consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
1 0
- swagger注释API详细说明
- swagger注释API详细说明
- swagger注释API详细说明
- swagger注解 详细说明
- swagger 注释
- Swagger与SpringMVC整合自动生成api(超详细)
- swagger常用注释
- 详细注释说明PHP分页原理
- spring security3 xml配置详细说明注释
- spring security3 xml配置详细说明注释
- API生命周期第二阶段——设计:如何设计API(基于swagger进行说明)
- swagger注解说明
- swagger常用注解说明
- swagger注解说明
- swagger常用注解说明
- swagger常用注解说明
- Swagger生成API文档
- Swagger API接口管理
- IDEA 集成的Subversion 使用中遇的问题
- Win内存分配函数(GlobalAlloc/HeapAlloc/LocalAlloc/VirtualAlloc)
- 科普游戏开发的三大步骤
- 乘机人记录分析api
- 缺陷报告的作用、要点、原则和二八定理
- swagger注释API详细说明
- 使用switch语句和if...else语句,计算2008年8月8日这一天,是该年中的第几天
- 2017对CSDN学院一些建议
- java 开源项目 免费
- 比较不错的几款开源的WPF Charts报表控件
- Android 如何调用第三方.so (.a) 文件
- 系统的简单注解
- Qt软件开发文档3---mainAPP调用dllManager中函数
- 【算法】程序猿不写代码是不对的38