perf(app): add the missing interface prompts

Author: wibus-wee

src/app.controller.ts

@@ -1,5 +1,5 @@
 import { Controller, Get, UseInterceptors } from "@nestjs/common";
-import { ApiTags } from "@nestjs/swagger";
+import { ApiOperation, ApiTags } from "@nestjs/swagger";
 import { AllowAllCorsInterceptor } from "./common/interceptors/allow-all-cors.interceptor";
 import PKG from "../package.json";
 
@@ -8,6 +8,7 @@ import PKG from "../package.json";
 export class AppController {
   @UseInterceptors(AllowAllCorsInterceptor)
   @Get(["/", "/info"])
+  @ApiOperation({ summary: "获取服务端版本等信息" })
   async appInfo() {
     return {
       name: PKG.name,
@@ -18,6 +19,7 @@ export class AppController {
     };
   }
   @Get(["/ping"])
+  @ApiOperation({ summary: "测试接口是否存活" })
   ping(): "pong" {
     return "pong";
   }

src/modules/comments/comments.controller.ts

@@ -44,6 +44,7 @@ export class CommentController {
 
   @Get("/")
   // @Auth()
+  @ApiOperation({ summary: "获取评论列表" })
   async getRecentlyComments(@Query() query: PagerDto) {
     const { size = 10, page = 1, status = 0 } = query;
     return transformDataToPaginate(
@@ -127,6 +128,7 @@ export class CommentController {
   }
 
   @Post("/reply/:id")
+  @ApiOperation({ summary: "回复评论" })
   @ApiParam({
     name: "id",
     description: "cid",

src/modules/configs/configs.controller.ts

@@ -3,11 +3,12 @@
  * @author: Wibus
  * @Date: 2022-08-02 23:41:21
  * @LastEditors: Wibus
- * @LastEditTime: 2022-08-03 00:04:59
+ * @LastEditTime: 2022-08-21 11:19:20
  * Coding With IU
  */
 
 import { Body, Controller, Get, Patch } from "@nestjs/common";
+import { ApiOperation } from "@nestjs/swagger";
 import { instanceToPlain } from "class-transformer";
 import { ApiName } from "~/common/decorator/openapi.decorator";
 import { ConfigsInterfaceKeys } from "./configs.interface";
@@ -19,6 +20,7 @@ export class ConfigsController {
   constructor(private readonly configsService: ConfigsService) {}
 
   @Get("/")
+  @ApiOperation({ summary: "获取配置" })
   async getOption() {
     const configs = await this.configsService.getAllConfigs();
     let result = {};
@@ -32,6 +34,7 @@ export class ConfigsController {
   }
 
   @Patch("/")
+  @ApiOperation({ summary: "更新配置" })
   async updateOption(@Body() body: any) {
     for (const key in body) {
       // 将 key 转换为驼峰式

src/modules/markdown/markdown.controller.ts

@@ -9,7 +9,7 @@ import {
   Query,
   Res,
 } from "@nestjs/common";
-import { ApiProperty } from "@nestjs/swagger";
+import { ApiOperation } from "@nestjs/swagger";
 import { Auth } from "~/common/decorator/auth.decorator";
 import { HTTPDecorators } from "~/common/decorator/http.decorator";
 import { ApiName } from "~/common/decorator/openapi.decorator";
@@ -26,7 +26,7 @@ export class MarkdownController {
 
   @Post("/export")
   @Auth()
-  @ApiProperty({ description: "导出部分 Markdown 文件" })
+  @ApiOperation({ summary: "导出部分 Markdown 文件" })
   @HTTPDecorators.Bypass
   async exportSomeMarkdowns(
     @Query() { showTitle, slug, yaml }: ExportMarkdownDto,
@@ -124,7 +124,7 @@ export class MarkdownController {
 
   @Get("/export/all")
   @Auth()
-  @ApiProperty({ description: "导出 Markdown YAML 数据" })
+  @ApiOperation({ summary: "导出 Markdown YAML 数据" })
   @HTTPDecorators.Bypass
   @Header("Content-Type", "application/zip")
   @Header("Content-Disposition", "attachment; filename=markdown.zip")
@@ -192,7 +192,7 @@ export class MarkdownController {
 
   @Post("/import")
   @Auth()
-  @ApiProperty({ description: "导入 Markdown YAML 数据" })
+  @ApiOperation({ summary: "导入 Markdown YAML 数据" })
   async importMarkdownData(@Body() body: ImportMarkdownDto) {
     const type = body.type;
 

src/modules/post/post.controller.ts

@@ -15,7 +15,6 @@ import { PostService } from "./post.service";
 import { Paginator } from "~/common/decorator/http.decorator";
 import { ApiName } from "~/common/decorator/openapi.decorator";
 import { PagerDto } from "~/shared/dto/pager.dto";
-import { addYearCondition } from "~/transformers/db-query.transformer";
 import { ApiOperation } from "@nestjs/swagger";
 import { CategoryAndSlugDto } from "./post.dto";
 import { CannotFindException } from "~/common/exceptions/cant-find.exception";
@@ -156,6 +155,7 @@ export class PostController {
   }
 
   @Get("/_like")
+  @ApiOperation({ summary: "点赞文章" })
   async thumbsUpArticle(
     @Query() query: MongoIdDto,
     @IpLocation() location: IpRecord