Skip to content

A
appbuild
Commit 0aa14217 authored by 赵啸非's avatar 赵啸非
Browse files
Options

添加apipost生成接口文档逻辑

parent bf933e77
Hide whitespace changes
Inline Side-by-side
Showing with 198 additions and 24 deletions
appbuild-manager/src/main/resources/template/doc/apipost.md.ftl
View file @ 0aa14217
...@@ -89,7 +89,33 @@ ...@@ -89,7 +89,33 @@
"body":{ "body":{
"mode":"json", "mode":"json",
"parameter":[ "parameter":[
{
"description": "用户名",
"is_checked": 1,
"key": "loginName",
"type": "Text",
"not_null": "1",
"field_type": "string",
"value": "admin"
},
{
"description": "密码",
"is_checked": 1,
"key": "password",
"type": "Text",
"not_null": "1",
"field_type": "string",
"value": "admin"
},
{
"description": "验证码",
"is_checked": 1,
"key": "securityCode",
"type": "Text",
"not_null": "1",
"field_type": "string",
"value": "123456"
}
], ],
"raw":"{\n\t\"loginName\": \"qixgyzp\",\n\t\"password\": \"ccfxeecffldl\",\n\t\"securityCode\": \"rjkw\"\n}", "raw":"{\n\t\"loginName\": \"qixgyzp\",\n\t\"password\": \"ccfxeecffldl\",\n\t\"securityCode\": \"rjkw\"\n}",
"raw_para":[ "raw_para":[
...@@ -588,7 +614,7 @@ ...@@ -588,7 +614,7 @@
"parameter":[ "parameter":[
], ],
"raw":"{\n\t\"loginName\": \"zyrndn\",\n\t\"oldPwd\": \"kpxbrprxok\",\n\t\"newPwd\": \"yyyfvyvybbbvy\"\n}", "raw":"",
"raw_para":[ "raw_para":[
], ],
...@@ -1041,8 +1067,56 @@ ...@@ -1041,8 +1067,56 @@
}, },
"body":{ "body":{
"mode":"json", "mode":"json",
"parameter":[], "parameter":[
"raw":"{\n\t\"page\": 9,\n\t\"size\": 29\n}", {
"description":"当前页",
"field_type":"integer",
"is_checked":1,
"key":"page",
"value":"1",
"not_null":-1,
"type":"integer"
},
{
"description":"每页条数，值为-1，查询所有记录",
"field_type":"integer",
"is_checked":1,
"key":"size",
"value":"10",
"not_null":-1,
"type":"integer"
}
<#list table.columns as column>
<#if column.isQuery == 1>
,{
<#if column.javaType=="String">
"description":"${column.columnComment},字段前后添加%%模糊查询",
"field_type":"string",
"type":"string",
<#elseif column.javaType == "Long"|| column.javaType=="Integer">
"description":"${column.columnComment}",
"field_type":"integer",
"type":"integer",
<#elseif column.javaType == "BigDecimal">
"field_type":"number",
"type":"number",
"description":"${column.columnComment}",
<#elseif column.javaType == "Date">
"field_type":"string",
"description":"${column.columnComment}",
"type":"string",
<#else>
"description":"${column.columnComment}",
"field_type":"string",
"type":"string",
</#if>
"key":"${column.javaField}",
"value":"${column.randomStr(column.javaType)}"
}
</#if>
</#list>
],
"raw":"",
"raw_para":[ "raw_para":[
{ {
"description":"当前页", "description":"当前页",
...@@ -1446,12 +1520,12 @@ ...@@ -1446,12 +1520,12 @@
}, },
{ {
"target_type":"api", "target_type":"api",
"name":"${table.functionName}详细查看", "name":"${table.functionName}详细",
"mark":"developing", "mark":"developing",
"sort":2, "sort":2,
"method":"GET", "method":"GET",
"mock":"{}", "mock":"{}",
"mock_url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/info", "mock_url":"${appInfo.path}/${table.requestMapping}/info",
"request":{ "request":{
"url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/info?${table.pkColumn.javaField}=@integer(1,10)", "url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/info?${table.pkColumn.javaField}=@integer(1,10)",
"description":"", "description":"",
...@@ -1469,7 +1543,7 @@ ...@@ -1469,7 +1543,7 @@
"key":"${table.pkColumn.javaField}", "key":"${table.pkColumn.javaField}",
"value":"@integer(1,10)", "value":"@integer(1,10)",
"not_null":1, "not_null":1,
"type":"Text" "type":"integer"
} }
], ],
"raw":"", "raw":"",
...@@ -1735,7 +1809,7 @@ ...@@ -1735,7 +1809,7 @@
"sort":3, "sort":3,
"method":"GET", "method":"GET",
"mock":"{}", "mock":"{}",
"mock_url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/delete", "mock_url":"${appInfo.path}/${table.requestMapping}/delete",
"request":{ "request":{
"url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/delete?${table.pkColumn.javaField}=@integer(1,10)&${table.pkColumn.javaField}=@integer(1,10)", "url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/delete?${table.pkColumn.javaField}=@integer(1,10)&${table.pkColumn.javaField}=@integer(1,10)",
"description":"", "description":"",
...@@ -1746,13 +1820,13 @@ ...@@ -1746,13 +1820,13 @@
"header":{ "header":{
"parameter":[ "parameter":[
{ {
"description":"token", "description":"用户登录鉴权token",
"field_type":"String", "field_type":"integer",
"is_checked":1, "is_checked":1,
"key":"Authorization", "key":"Authorization",
"value":"@uuid", "value":"{{token}}}",
"not_null":1, "not_null":1,
"type":"Text" "type":"integer"
} }
] ]
}, },
...@@ -1765,7 +1839,7 @@ ...@@ -1765,7 +1839,7 @@
"key":"${table.pkColumn.javaField}", "key":"${table.pkColumn.javaField}",
"value":"@integer(1,10)", "value":"@integer(1,10)",
"not_null":1, "not_null":1,
"type":"Text" "type":"integer"
}, },
{ {
"description":"ID", "description":"ID",
...@@ -1774,7 +1848,7 @@ ...@@ -1774,7 +1848,7 @@
"key":"${table.pkColumn.javaField}", "key":"${table.pkColumn.javaField}",
"value":"@integer(1,10)", "value":"@integer(1,10)",
"not_null":1, "not_null":1,
"type":"Text" "type":"integer"
} }
] ]
} }
...@@ -1848,23 +1922,71 @@ ...@@ -1848,23 +1922,71 @@
"sort":4, "sort":4,
"method":"POST", "method":"POST",
"mock":"{}", "mock":"{}",
"mock_url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/save", "mock_url":"${appInfo.path}/${table.requestMapping}/save",
"request":{ "request":{
"url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/save", "url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/save",
"description":"${table.pkColumn.javaField}为空时为新增保存，否则为更新提交", "description":"${table.pkColumn.javaField}为空时为新增保存，否则为更新提交",
"event":{ "event":{
"pre_script":"", "pre_script":"",
"test":"" "test":""
},
"header":{
"parameter":[
{
"description":"用户登录鉴权token",
"field_type":"String",
"is_checked":1,
"key":"Authorization",
"value":"{{token}}}",
"not_null":1,
"type":"Text"
}
]
}, },
"body":{ "body":{
"mode":"json", "mode":"json",
"parameter":[ "parameter":[
{
"description":"${table.pkColumn.javaField}为空时为新增，否则为更新",
"field_type":"integer",
"is_checked":1,
"key":"${table.pkColumn.javaField}",
"value":"1",
"not_null":-1,
"type":"${table.pkColumn.javaType}"
},
<#assign isFirst>true</#assign>
<#list table.columns as column>
<#if !column.isSuperColumn(column.javaField)>
<#if isFirst == "false">,</#if>
<#assign isFirst>false</#assign>
{
"key":"${column.javaField}",
"is_checked": 1,
<#if column.javaType=="String">
"field_type":"string",
"type":"string",
<#elseif column.javaType == "Long"|| column.javaType=="Integer">
"field_type":"integer",
"type":"integer",
<#elseif column.javaType == "BigDecimal">
"field_type":"number",
"type":"number",
<#elseif column.javaType == "Date">
"field_type":"string",
"type":"string",
<#else>
"field_type":"string",
"type":"string",
</#if>
"value":"${column.randomStr(column.javaType)}",
"description": "${column.columnComment}"
}
</#if>
</#list>
], ],
"raw":"", "raw":"",
"raw_para":[ "raw_para":[],
],
"raw_schema":{ "raw_schema":{
"type":"object", "type":"object",
"properties":{ "properties":{
...@@ -2256,17 +2378,69 @@ ...@@ -2256,17 +2378,69 @@
"sort":5, "sort":5,
"method":"POST", "method":"POST",
"mock":"{}", "mock":"{}",
"mock_url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/batchSave", "mock_url":"${appInfo.path}/${table.requestMapping}/batchSave",
"request":{ "request":{
"url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/batchSave", "url":"{{baseUrl}}${appInfo.path}/${table.requestMapping}/batchSave",
"description":"", "description":"",
"event":{ "event":{
"pre_script":"", "pre_script":"",
"test":"" "test":""
},
"header":{
"parameter":[
{
"description":"用户登录鉴权token",
"field_type":"String",
"is_checked":1,
"key":"Authorization",
"value":"{{token}}}",
"not_null":1,
"type":"Text"
}
]
}, },
"body":{ "body":{
"mode":"json", "mode":"json",
"parameter":[], "parameter":[
{
"description":"${table.pkColumn.javaField}为空时为新增，否则为更新",
"field_type":"integer",
"is_checked":1,
"key":"${table.pkColumn.javaField}",
"value":"1",
"not_null":-1,
"type":"${table.pkColumn.javaType}"
},
<#assign isFirst>true</#assign>
<#list table.columns as column>
<#if !column.isSuperColumn(column.javaField)>
<#if isFirst == "false">,</#if>
<#assign isFirst>false</#assign>
{
"key":"${column.javaField}",
"is_checked": 1,
<#if column.javaType=="String">
"field_type":"string",
"type":"string",
<#elseif column.javaType == "Long"|| column.javaType=="Integer">
"field_type":"integer",
"type":"integer",
<#elseif column.javaType == "BigDecimal">
"field_type":"number",
"type":"number",
<#elseif column.javaType == "Date">
"field_type":"string",
"type":"string",
<#else>
"field_type":"string",
"type":"string",
</#if>
"value":"${column.randomStr(column.javaType)}",
"description": "${column.columnComment}"
}
</#if>
</#list>
],
"raw":"", "raw":"",
"raw_para":[ "raw_para":[
...@@ -2471,7 +2645,7 @@ ...@@ -2471,7 +2645,7 @@
"sort": 6, "sort": 6,
"method": "POST", "method": "POST",
"mock": "{}", "mock": "{}",
"mock_url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/downloadTemplate", "mock_url": "${appInfo.path}/${table.requestMapping}/downloadTemplate",
"request": { "request": {
"url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/downloadTemplate", "url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/downloadTemplate",
"description": "", "description": "",
...@@ -2517,7 +2691,7 @@ ...@@ -2517,7 +2691,7 @@
"sort": 7, "sort": 7,
"method": "POST", "method": "POST",
"mock": "{}", "mock": "{}",
"mock_url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/exportExcel", "mock_url": "${appInfo.path}/${table.requestMapping}/exportExcel",
"request": { "request": {
"url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/exportExcel", "url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/exportExcel",
"description": "", "description": "",
...@@ -2627,7 +2801,7 @@ ...@@ -2627,7 +2801,7 @@
"sort": 8, "sort": 8,
"method": "POST", "method": "POST",
"mock": "{}", "mock": "{}",
"mock_url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/importData", "mock_url": "${appInfo.path}/${table.requestMapping}/importData",
"request": { "request": {
"url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/importData", "url": "{{baseUrl}}${appInfo.path}/${table.requestMapping}/importData",
"description": "", "description": "",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment