Metrics
0
Watch 355 Star 1.3K Fork 338

萧明 / knife4jJavaApache-2.0

Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui spread retract

http://doc.xiaominfo.com/

Clone or download
swagger-annotation.md 1.11 KB
Copy Edit Web IDE Raw Blame History
肖玉明 authored 2017-04-19 14:59 . init

Swagger 注解说明

Swagger的注解位于swagger-annotations基础jar包中,如图:

常用注解说明

  • @Api:一般用于Controller中,用于接口分组,使用如下图:

  • @ApiOperation:接口说明,用于api方法上

  • @ApiImplicitParam:参数说明,适用于只有一个请求参数,主要参数 | 模块名称 | 说明 | | :--- | :--- | | name | 参数名称 | | value | 参数中文说明 | | required | 是否请求必须,boolean值 | | dataType | 数据类型 |

  • @ApiImplicitParams:多个参数说明,主要参数参考上面@ApiImplicitParam

  • @ApiModelProperty:实体参数说明

实体类:

Controller类:

Comment ( 0 )

You need to Sign in for post a comment

Java
1
https://gitee.com/xiaoym/knife4j.git
git@gitee.com:xiaoym/knife4j.git

Help Search