add swagger

This commit is contained in:
liuyi 2025-06-16 23:01:20 +08:00
parent b6bc983f08
commit d8c1adf08b

View File

@ -25,16 +25,32 @@ import { PaginateOptions } from '@/modules/database/types';
import { CategoryEntity, PostEntity, TagEntity } from '../entities';
/**
*
*/
@DtoValidation({ type: 'query' })
export class QueryPostDto implements PaginateOptions {
/**
* (全部文章:不填只查询已发布的:true只查询未发布的:false)
*/
@Transform(({ value }) => toBoolean(value))
@IsBoolean()
@IsOptional()
isPublished?: boolean;
/**
*
*/
@MaxLength(100, {
always: true,
message: '搜索字符串长度不得超过$constraint1',
})
@IsOptional()
search?: string;
/**
* ,
*/
@IsEnum(PostOrder, {
message: `The sorting rule must be one of ${Object.values(PostOrder).join(',')}`,
})
@ -60,11 +76,17 @@ export class QueryPostDto implements PaginateOptions {
@IsOptional()
trashed?: SelectTrashMode;
/**
* ID查询此分类及其后代分类下的文章
*/
@IsDataExist(CategoryEntity, { always: true, message: 'The category does not exist' })
@IsUUID(undefined, { message: 'The ID format is incorrect' })
@IsOptional()
category?: string;
/**
* ID查询
*/
@IsUUID(undefined, { message: 'The ID format is incorrect' })
@IsOptional()
tag?: string;