ofa集成了swagger,通过在代码中添加注解,能自动生成api文档,方便前端进行对接和调试。
常用注解说明
注解 | 说明 |
---|---|
Api | Api 用在类上,说明该类的作用。可以标记一个Controller类做为swagger文档资源 |
ApiOperation | 用在方法上,说明方法的作用 |
ApiParam | 请求参数 |
ApiModel | 描述一个Model的信息 |
ApiModelProperty | 描述一个model的属性 |
ApiImplicitParams | 用在方法上包含一组参数说明 |
ofa将swagger聚合在网关,也就是说通过访问网关,可以通过切换右上角来看到不同服务的接口文档。