feat: apiItem 添加 title 属性（中文标题）

Author: lemon-clown

index.d.ts

@@ -11,6 +11,7 @@ declare namespace ApiTool {
     DEL = 'DEL',
     DELETE = 'DELETE'
   }
+
   /**
    * api 组
    * @member name                 组名
@@ -30,9 +31,11 @@ declare namespace ApiTool {
     requestModelSuffix: string
     responseModelSuffix: string
   }
+
   /**
    * api 接口条目
-   * @member name               接口名称
+   * @member name               接口名称（英文名称）
+   * @member title              接口名称（中文名称，当配置文件中未指定 title，该值置为 name 的值）
    * @member url                接口路径
    * @member desc               描述
    * @member method             http 方法
@@ -44,6 +47,7 @@ declare namespace ApiTool {
    */
   export interface ApiItem {
     name: string
+    title: string
     url: string
     desc: string
     method: HttpVerb
@@ -53,10 +57,12 @@ declare namespace ApiTool {
     requestModel?: string
     responseModel?: string
   }
+
   /**
    * 配置文件中的 api 条目，需要置于 api 组下
    *
    * @member name               api 条目的名称；构成自动生成的 requestModel、responseModel、requestSchemaPath、responseSchemaPath 的一部分
+   * @member title              api 条目的名称（中文名称）
    * @member url                api 条目的路由（最终的路由以所属组中定义的 url 作为前缀）；default: ''
    * @member desc               api 条目的描述；default: ''
    * @member method             api 条目的 http 请求方法（覆盖 group 中的 method）；default: undefined
@@ -73,6 +79,7 @@ declare namespace ApiTool {
   export interface RawApiItem {
     name: string
     url?: string
+    title?: string
     desc?: string
     method?: HttpVerb
     model?: string
@@ -81,6 +88,7 @@ declare namespace ApiTool {
     requestSchemaPath?: string
     responseSchemaPath?: string
   }
+
   /**
    * 配置文件中的 api 组
    *

src/core/api-item/parser.ts

@@ -123,6 +123,7 @@ export class ApiItemParser {
     const apiItems: ApiItem[] = []
     for (const rawItem of rawApiItems) {
       const name: string = rawItem.name
+      const title = coverString(name, rawItem.title)
       const url: string = apiItemGroup.url + coverString('', rawItem.url)
       const desc: string = coverString('', rawItem.desc)
       const method: HttpVerb = cover<HttpVerb>(apiItemGroup.method, rawItem.method)
@@ -161,7 +162,7 @@ export class ApiItemParser {
         : path.join(pn, responseSchemaName)
 
       const apiItem: ApiItem = {
-        name, url, desc, method, group,
+        name, title, url, desc, method, group,
         requestModel, responseModel, requestSchemaPath, responseSchemaPath
       }
       apiItems.push(apiItem)
@@ -215,9 +216,9 @@ export class ApiItemParser {
     if (data == null || typeof data !== 'object') return []
     const rawApiItems: RawApiItem[] = []
     for (const [name, rawItem] of Object.entries<RawApiItem>(data)) {
-      const { url, desc, method, model, requestModel, responseModel, requestSchemaPath, responseSchemaPath } = rawItem
+      const { url, desc, title, method, model, requestModel, responseModel, requestSchemaPath, responseSchemaPath } = rawItem
       const rawApiItem: RawApiItem = {
-        name, url, desc, method, model,
+        name, url, desc, title, method, model,
         requestModel, responseModel, requestSchemaPath, responseSchemaPath
       }
       rawApiItems.push(rawApiItem)

src/core/api-item/types.ts

@@ -31,7 +31,8 @@ export interface ApiItemGroup {
 
 /**
  * api 接口条目
- * @member name               接口名称
+ * @member name               接口名称（英文名称）
+ * @member title              接口名称（中文名称，当配置文件中未指定 title，该值置为 name 的值）
  * @member url                接口路径
  * @member desc               描述
  * @member method             http 方法
@@ -43,6 +44,7 @@ export interface ApiItemGroup {
  */
 export interface ApiItem {
   name: string
+  title: string
   url: string
   desc: string
   method: HttpVerb
@@ -58,6 +60,7 @@ export interface ApiItem {
  * 配置文件中的 api 条目，需要置于 api 组下
  *
  * @member name               api 条目的名称；构成自动生成的 requestModel、responseModel、requestSchemaPath、responseSchemaPath 的一部分
+ * @member title              api 条目的名称（中文名称）
  * @member url                api 条目的路由（最终的路由以所属组中定义的 url 作为前缀）；default: ''
  * @member desc               api 条目的描述；default: ''
  * @member method             api 条目的 http 请求方法（覆盖 group 中的 method）；default: undefined
@@ -74,6 +77,7 @@ export interface ApiItem {
 export interface RawApiItem {
   name: string
   url?: string
+  title?: string
   desc?: string
   method?: HttpVerb
   model?: string