nest.js 添加 swagger 响应数据文档 | 愧怍

[giscus[bot]]

nest.js 添加 swagger 响应数据文档 | 愧怍

愧怍的个人博客

https://kuizuo.cn/blog/nest-swagger-response-data

[zzzcccyyyggg]

1

[kuizuo]

2

[abigmiu]

谢谢博主，弄成功了，ApiExtraModels(model) 里面还要加个ResOp => ApiExtraModels(model, ResOp)

[abigmiu]

import { applyDecorators, Type } from '@nestjs/common';
import {
  ApiExtraModels,
  ApiOkResponse,
  ApiResponseSchemaHost,
  getSchemaPath,
} from '@nestjs/swagger';
import { AppApiResponse, PagerResponse } from 'src/types/response';

export function SuccessResponse<T extends Type<any>>(
  model?: T,
  config?: { pager?: boolean; array?: boolean },
) {
  const baseTypeNames = ['String', 'Number', 'Boolean'];
  const { pager = false, array = false } = config || {};
  let prop: ApiResponseSchemaHost['schema']['properties']['data'];
  if (pager) {
    prop = {
      allOf: [
        {
          $ref: getSchemaPath(PagerResponse),
        },
        {
          properties: {
            items: {
              $ref: getSchemaPath(model),
            },
          },
        },
      ],
    };
  } else if (array) {
    prop = {
      type: 'array',
      items: { $ref: getSchemaPath(model) },
    };
  } else if (model) {
    if (baseTypeNames.includes(model.name)) {
      prop = {
        type: model.name.toLowerCase(),
      };
    } else {
      prop = {
        $ref: getSchemaPath(model),
      };
    }
  } else {
    prop = {
      default: null,
      type: 'null',
    };
  }
  return applyDecorators(
    ApiExtraModels(model, AppApiResponse, PagerResponse),
    ApiOkResponse({
      description: '成功',
      schema: {
        allOf: [
          {
            $ref: getSchemaPath(AppApiResponse),
          },
          {
            properties: {
              data: prop,
            },
          },
        ],
      },
    }),
  );
}