文档章节

Swagger注解

Geeyu
 Geeyu
发布于 2017/06/01 10:54
字数 221
阅读 59
收藏 0

在Controller代码中使用swagger提供的注解,暴露Api。

类注解

@Api

说明该类的作用

  • tags 标签,用于逻辑分组,如果不使用,生成的文档会使用方法名
  • protocols 使用的协议
  • description 描述

@ApiIgnore

隐藏Api

方法注解

@ApiOperation

说明方法的作用

  • value 方法概要,120字符以内
  • notes 方法详述
  • consumes content格式,如"application/json, application/xml","- multipart/form-data"(用于Swagger文件上传)

@ApiImplicitParams / @ApiImplicitParam

说明单个参数

  • name 参数名
  • value 参数的意思
  • required 参数是否必须传
  • dataType 参数数据类型(类类型)
  • paramType 参数类型,可以为path,query,body,header,form
    @ApiImplicitParams({
            @ApiImplicitParam(value = "id", name = "user_id", dataType = "Integer", paramType = "path"),
            @ApiImplicitParam(value = "字段", name = "fields", dataType = "String", paramType = "query", required = true)
    })

@ApiResponses / @ApiResponse

后者只能用在前者中,如果是通用的返回码,应该注解类

  • code 返回码
  • message 说明
  • response 返回实体

© 著作权归作者所有

Geeyu
粉丝 3
博文 57
码字总数 30351
作品 0
昌平
私信 提问
基于 Swagger 的前端 UI 实现 - Swagger-UI-layer

Swagger-UI-layer 是一个基于 Swagger 的前端 UI 实现,是为了替换了默认的 SwaggerUI,让生成的文档更加友好和美观。 Swagger-UI-layer 要依赖 Swagger 的注解功能,因为 Swagger-UI-layer...

五只鸭子
2017/09/13
12.3K
15
五只鸭子/Swagger-UI-layer

swagger-ui-layer swagger-ui-layer 是一个基于swagger的前端UI实现,是为了替换了默认的swagger-ui,让生成的文档更加友好和美观 swagger-ui-layer 要依赖swagger的注解功能,因为swagger-ui-...

五只鸭子
2018/09/12
0
0
swagger-bootstrap-ui 1.8.5 发布,Swagger增强UI实现

swagger-bootstrap-ui 1.8.5 发布了。swagger-bootstrap-ui 是 Swagger 的增强UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui在1.8.5以后...

八一菜刀
2018/10/16
5.4K
8
swagger-bootstrap-ui 1.7.8发布,Swagger前端UI实现

swagger-bootstrap-ui 1.7.8 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿 swagger-bootstrap-ui 1.7.8 主...

八一菜刀
2018/08/03
1K
5
Dubbo 的 Swagger 服务文档 - swagger-dubbo

swagger-dubbo支持dubbo以swagger方式展示文档和rest风格的HTTP模拟测试,主要应用场景有以下几点: 通过dubbo与swagger的集成,提供接口文档的阅读 开发人员可以用它来自测服务接口,也可以...

Sayi
2018/06/07
3.1K
4

没有更多内容

加载失败,请刷新页面

加载更多

获取文件路径

//获取根目录 File path = new File(ResourceUtils.getURL("classpath:").getPath()); if (!path.exists()) path = new File(""); String FILE_PATH =path.getCanonicalPath(); //如果上传目......

简小姐
33分钟前
3
0
Postgresql 字符类型异常error: operator does not exist: bigint = character varying

问题参考: https://www.postgresql.org/message-id/4682D2C9.1010406@aspix.it 类型不对应: 只要类型对上了就不会出错。

boonya
34分钟前
3
0
Spring Security 实战干货:路径Uri中的 Ant 风格

1. 前言 我们经常在读到一些文章会遇到uri 支持 Ant 风格 ,而且这个东西在 Spring MVC 和 Spring Security 中经常被提及。这到底是什么呢?今天我们来学习了解一下。这对我们学习 Spring M...

码农小胖哥
47分钟前
2
0
Ajax在表单中的应用

本文转载于:专业的前端网站➺Ajax在表单中的应用 ajax在注册用户表单中的使用 1.验证用户名是否被使用 2.获取手机短信验证码 3.点击表单中的图片刷新,可实现刷新图片验证码 <!DOCTYPE html...

前端老手
51分钟前
1
0
关于谷歌浏览器崩溃,打不开任何界面

首先:谷歌浏览器右键打开属性,在箭头所指的位置复制粘贴 -no-sandbox。(需要空一格再写入 -no-sandbox) 其次:你打开谷歌浏览器可以看到如下提醒,提醒你,稳定性和安全性会有所下降,但...

Raphael98
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部