浏览代码

修改生成api文档模板

lichunlei 7 月之前
父节点
当前提交
7685faf16c
共有 4 个文件被更改,包括 16 次插入19 次删除
  1. 4 4
      Template/ApiDoc/doc.json
  2. 3 3
      Template/Sql/db.sql
  3. 3 6
      Template/Sql/dbField.sql
  4. 6 6
      Template/Sql/dbTable.sql

+ 4 - 4
Template/ApiDoc/doc.json

@@ -1,8 +1,8 @@
 {
   "openapi": "3.1.0",
   "info": {
-    "title": "<<ym:serviceName>>",
-    "description": "<<ym:serviceName>>的API文档",
+    "title": "<<ym:serviceTitle>>",
+    "description": "<<ym:serviceTitle>>的API文档",
     "version": "1.0.0"
   },
   "tags": [
@@ -13,13 +13,13 @@
   ],
   "paths": {
     <<ym-loop:apiInfo removeEnd=",">>
-    "/<<apiVersionNo>>/<<serviceName>>/<<groupName>>/<<methodName>>": {
+    "/v<<version>>/<<ym:serviceName>>/<<groupName>>/<<methodName>>": {
       "<<ym-if:<<apiKind>><3>>get<</ym-if>><<ym-if:<<apiKind>>=3>>post<</ym-if>><<ym-if:<<apiKind>>=4>>put<</ym-if>><<ym-if:<<apiKind>>=5>>delete<</ym-if>>": {
         "summary": "<<apiName>>",
         "x-apifox-folder": "<<groupName>>",
         "x-apifox-status": "released",
         "deprecated": false,
-        "description": "<div><div class=\"tips\"><strong>注意事项</strong><br><p><<apiDetail>></p><br></div><div class=\"apicontent apicontent2\"><strong>返回报文示例:</strong><br><pre>{<br> status: \"1\",<br>msg: \"\",<br> data: [{<br> }]<br>}<br></pre></div><div class=\"apicontent apicontent2\"><strong>axios调用示例</strong><br><pre>const params = {\n};\nRequest({\n    url: this.UrlList.<<serviceName>>.<<groupName>><<methodName>>.url,\n    method: this.UrlList.<<serviceName>>.<<groupName>><<methodName>>.method,\n    params,\n})\n.then((res) => {\n    if (res.status == 1) {\n        // 返回参数正确逻辑\n    } else {\n        PublicFn.tips(res.msg);\n    }\n})\n.catch((e) => {\n    console.log(e);\n});\n<br></pre></div></div></div>",
+        "description": "<div><div class=\"tips\"><strong>注意事项</strong><br><p><<apiDetail>></p><br></div><div class=\"apicontent apicontent2\"><strong>返回报文示例:</strong><br><pre>{<br> status: \"1\",<br>msg: \"\",<br> data: [{<br> }]<br>}<br></pre></div><div class=\"apicontent apicontent2\"><strong>axios调用示例</strong><br><pre>const params = {\n};\nRequest({\n    url: this.UrlList.<<ym:serviceName>>.<<groupName>><<methodName>>.url,\n    method: this.UrlList.<<ym:serviceName>>.<<groupName>><<methodName>>.method,\n    params,\n})\n.then((res) => {\n    if (res.status == 1) {\n        // 返回参数正确逻辑\n    } else {\n        PublicFn.tips(res.msg);\n    }\n})\n.catch((e) => {\n    console.log(e);\n});\n<br></pre></div></div></div>",
         "tags": [
           "<<groupName>>"
         ],

+ 3 - 3
Template/Sql/db.sql

@@ -8,9 +8,9 @@ GRANT create,alter,drop,select,insert,update,delete ON <<username>>.* TO <<usern
 <<ym-loop:databaseTable>>
 DROP TABLE IF EXISTS <<tableName>>;
 CREATE table <<tableName>>(
-<<ym-loop:databaseField>>
+<<ym-loop:fields>>
 <<fieldName>> <<fieldType>><<ym-if:!isEmpty(<<fieldLength>>)>>(<<fieldLength>>)<</ym-if>><<ym-if:<<notNull>>=1>> not null<</ym-if>><<ym-if:<<autoIncrement>>=1>> AUTO_INCREMENT<</ym-if>><<ym-if:!isEmpty(<<fieldDefaultValue>>)>> default <<fieldDefaultValue>><</ym-if>> COMMENT <<fieldTitle>><<fieldDetail>>,
-<</ym-loop:databaseField>>
-PRIMARY KEY(<<ym-loop:databaseField removeEnd=",">><<fieldName>>,<</ym-loop:databaseField>>)
+<</ym-loop:fields>>
+PRIMARY KEY(<<ym-loop:fields removeEnd=",">><<fieldName>>,<</ym-loop:fields>>)
 ) COMMENT '<<tableTitle>>' ENGINE=InnoDB DEFAULT charset=utf8mb4 COLLATE utf8mb4_general_ci;
 <</ym-loop:databaseTable>>

+ 3 - 6
Template/Sql/dbField.sql

@@ -1,6 +1,3 @@
-<<ym-item:databaseTable>>
-Alter table <<tableName>> <<ym:opType>> 
-<</ym-item:databaseTable>>
-<<ym-item:databaseField>>
-<<fieldName>> <<fieldType>><<ym-if !isEmpty(<<fieldLength>>)>>(<<fieldLength>>)<</ym-if>><<ym-if <<notNull>>=1>> not null<</ym-if>><<ym-if <<autoIncrement>>=1>> AUTO_INCREMENT<</ym-if>><<ym-if !isEmpty(<<fieldDefaultValue>>)>> default <<fieldDefaultValue>><</ym-if>> COMMENT <<fieldTitle>><<fieldDetail>>;
-<</ym-item:databaseField>>
+<<ym-loop:databaseField>>
+Alter table <<ym:tableName>> <<ym:opType>> <<fieldName>> <<fieldType>><<ym-if !isEmpty(<<fieldLength>>)>>(<<fieldLength>>)<</ym-if>><<ym-if <<notNull>>=1>> not null<</ym-if>><<ym-if <<autoIncrement>>=1>> AUTO_INCREMENT<</ym-if>><<ym-if !isEmpty(<<fieldDefaultValue>>)>> default <<fieldDefaultValue>><</ym-if>> COMMENT <<fieldTitle>><<fieldDetail>>;
+<</ym-loop:databaseField>>

+ 6 - 6
Template/Sql/dbTable.sql

@@ -1,13 +1,13 @@
-<<ym-item:databaseTable>>
+<<ym-loop:databaseTable>>
 DROP TABLE IF EXISTS <<tableName>>;
 CREATE table <<tableName>>(
-<<ym-loop:databaseField>>
+<<ym-loop:fields>>
 <<fieldName>> <<fieldType>><<ym-if:!isEmpty(<<fieldLength>>)>>(<<fieldLength>>)<</ym-if>><<ym-if:<<notNull>>="1">> not null<</ym-if>><<ym-if:<<autoIncrement>>="1">> AUTO_INCREMENT<</ym-if>><<ym-if:!isEmpty(<<fieldDefaultValue>>)>> default <<fieldDefaultValue>><</ym-if>> COMMENT <<fieldTitle>><<fieldDetail>>,
-<</ym-loop:databaseField>>
+<</ym-loop:fields>>
 PRIMARY KEY(
-<<ym-loop:databaseField removeEnd=",">>
+<<ym-loop:fields removeEnd=",">>
 <<fieldName>>,
-<</ym-loop:databaseField>>
+<</ym-loop:fields>>
 )
 ) COMMENT '<<tableTitle>>' ENGINE=InnoDB DEFAULT charset=utf8mb4 COLLATE utf8mb4_general_ci;
-<</ym-item:databaseTable>>
+<</ym-loop:databaseTable>>