如何解决TypeScript 和 Swagger:创建一个通用的 GetManyAndCount 类定义
我有一组 Item
对象。从 REST API(使用 Node.js 和 nest.js),我返回了许多对象和数据库中所有可用对象的计数:
type Response = {
many: Item[];
count: number;
}
我也在使用 Swagger 和 TypeScript 代码库(我正在使用 nest.js 及其 Swagger 插件)。
在这里,我想将类定义指定为 API 控制器 (Response
) 上的返回类型,而不是使用 : Promise<GetManyItemsAndCountDto>
类型,因此 API 响应会自动记录在 Swagger 架构中:
export class GetManyItemsAndCountDto extends GetManyAndCountType(Item) {}
export class ItemsController {
async getItems(/* ... */): Promise<GetManyItemsAndCountDto> {
// ...
}
}
像这里一样,在我的项目中,所有返回对象集合的 API 也返回一个 count
。
如何正确定义通用且可重用的 GetManyAndCountType()
类/函数,以便使用 Swagger 正确记录响应定义?
我尝试过的:
- 我使用 mixin 尝试了以下解决方案(受 another use case 启发)。
GetManyItemsAndCountDto
在 swagger json 模式中很好地创建,但只是作为一个“对象”,没有它的 2 个属性:many: Items[]
和count: number
,这是无用的。
interface IGetManyAndCount<T> {
many: T[];
count: number;
}
export function GetManyAndCountType<T>(ResourceClass) {
return class GetManyAndCount implements IGetManyAndCount<T> {
many: typeof ResourceClass[];
count: number;
};
}
export class GetManyItemsAndCountDto extends GetManyAndCountType(Items) {}
export class GetManyItemsAndCountDto {
many: Item[];
count: number;
}
预先感谢您的任何帮助或评论。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。