介绍
我前段时间提供了一个【swagger2-to-ts】工具,那么就需要为后端提供基本的Swagger注解规范。这里用这篇文章来说明相关配置。
服务的注解
如下图:
- title:服务的英文,必须用英文,如:influence-manage
- description:服务的中文名称,必须是中文,如:达人运营服务
实体模型注解
如下图:
- @ApiModel:实体描述,必须以"description='XXXX'"为准。
接口重复
有时,出现对接口描述的重复如下:
那么请使用Nickname 这种覆盖默认 operationId 的方法,如下:
总结
这个文章是给公司的内部人员使用,外部人员看看知道就行。