Swagger生成API文档


swagger通过装饰器生成标准openApi文档;

装饰方法

@ApiTag:定义分组信息

  • @ApiTag('分组名')
    @ApiOperation:生成接口概述
  • @ApiOperation({ summary: '用户登陆' })
    @ApiResponse:定义返回值格式
  • @ApiResponse({ status: 200, type: String})
    @ApiQuery:定义get请求传入参数
  • @ApiQuery({ name: 'pageNum', description: '页码', type: Number })

装饰参数

@Param:获取get请求地址中对应字段作为参数

  • (@Param('id') task_id: string)

文章作者: Semon
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 Semon !
评论
  目录