swagger-tools、swagger-core、swagger-ui。。。。

1.swagger功能

Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。

Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。

Swagger-js: 用于JavaScript的Swagger实现。

Swagger-node-express: Swagger模块,用于node.js的Express web应用框架。

Swagger-ui:一个无依赖的HTML、JS和CSS集合,可以为Swagger兼容API动态生成优雅文档。

Swagger-codegen:一个模板驱动引擎,通过分析用户Swagger资源声明以各种语言生成客户端代码。

2.swagger的基本注解使用

-@Api:用在类上,说明该类的作用。

-@ApiOperation:注解来给API增加方法说明。

-@ApiImplicitParams : 用在方法上包含一组参数说明。

 -@ApiImplicitParam:用来注解来给方法入参增加说明。   -@ApiResponses:用于表示一组响应

 -@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
     code:数字,例如400
     message:信息,例如"请求参数没填好"
  	 response:抛出异常的类     -@ApiModel:描述一个Model的信息(一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候)

 @ApiModelProperty:描述一个model的属性
原创文章转载请注明出处: swagger-简单总结