Merge pull request #175 from tangcent/dev/v2.0.0

feat: show attr of param with @requestbody for `yapi`
tangcent · Apr 26, 2020 · a0bb5a0 · a0bb5a0
2 parents 1202c09 + c1a49fa
commit a0bb5a0
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 14 deletions.
diff --git a/common-api/src/main/kotlin/com/itangcent/common/model/Request.kt b/common-api/src/main/kotlin/com/itangcent/common/model/Request.kt
@@ -35,6 +35,11 @@ open class Request : Doc() {
 
     var body: Any? = null
 
+    /**
+     * The description of [body] if it is present.
+     */
+    var bodyAttr: String? = null
+
     var response: MutableList<Response>? = null
 }
 

diff --git a/common-api/src/main/kotlin/com/itangcent/common/model/URL.kt b/common-api/src/main/kotlin/com/itangcent/common/model/URL.kt
@@ -145,7 +145,7 @@ private class SingleURL(private val url: String) : URL {
     }
 
     override fun concat(url: URL): URL {
-        return url.map { RequestUtils.contractPath(this.url, it) }
+        return url.map { RequestUtils.concatPath(this.url, it) }
     }
 
     override fun union(url: URL): URL {

diff --git a/common-api/src/main/kotlin/com/itangcent/http/RequestUtils.kt b/common-api/src/main/kotlin/com/itangcent/http/RequestUtils.kt
@@ -37,7 +37,7 @@ object RequestUtils {
         return body
     }
 
-    fun contractPath(pathPre: String?, pathAfter: String?): String? {
+    fun concatPath(pathPre: String?, pathAfter: String?): String? {
         if (pathPre.isNullOrBlank()) return pathAfter
         if (pathAfter.isNullOrBlank()) return pathPre
         return pathPre.removeSuffix("/") + "/" + pathAfter.removePrefix("/")

diff --git a/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/DefaultRequestHelper.kt b/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/DefaultRequestHelper.kt
@@ -66,6 +66,7 @@ open class DefaultRequestHelper : RequestHelper {
 
     override fun setJsonBody(request: Request, body: Any?, bodyAttr: String?) {
         request.body = body
+        request.bodyAttr = bodyAttr
     }
 
     override fun appendDesc(request: Request, desc: String?) {

diff --git a/...plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/markdown/MarkdownFormatter.kt b/...plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/markdown/MarkdownFormatter.kt
@@ -245,7 +245,7 @@ class MarkdownFormatter {
             handle("\n**RequestBody**\n\n")
             handle("| name  |  type  |  desc  |\n")
             handle("| ------------ | ------------ | ------------ |\n")
-            parseBody(0, "", "", request.body, handle)
+            parseBody(0, "", request.bodyAttr ?: "", request.body, handle)
 
             if (settingBinder!!.read().outputDemo) {
                 handle("\n**Request Demo：**\n\n")

diff --git a/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/postman/PostmanFormatter.kt b/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/postman/PostmanFormatter.kt
@@ -15,7 +15,6 @@ import com.itangcent.idea.psi.ResourceHelper
 import com.itangcent.idea.psi.resource
 import com.itangcent.idea.psi.resourceClass
 import com.itangcent.idea.utils.ModuleHelper
-import com.itangcent.intellij.config.ConfigReader
 import com.itangcent.intellij.config.rule.RuleComputer
 import com.itangcent.intellij.context.ActionContext
 import com.itangcent.intellij.util.ActionUtils
@@ -54,7 +53,7 @@ class PostmanFormatter {
         if (pathInRequest.single()) {
             val path = pathInRequest.url() ?: ""
             url["path"] = path.trim().trim('/').split("/")
-            url["raw"] = RequestUtils.contractPath(url.getAs("host"), path)
+            url["raw"] = RequestUtils.concatPath(url.getAs("host"), path)
             return listOf(item)
         }
 
@@ -68,7 +67,7 @@ class PostmanFormatter {
                 val copyItem = copyItem(item)
                 val copyUrl: HashMap<String, Any?> = copyItem.getAs("request", "url")!!
                 copyUrl["path"] = it.trim().trim('/').split("/")
-                copyUrl["raw"] = RequestUtils.contractPath(host, it)
+                copyUrl["raw"] = RequestUtils.concatPath(host, it)
                 return@map copyItem
             }
         } else {
@@ -89,7 +88,7 @@ class PostmanFormatter {
             }
 
             url["path"] = (path ?: "").trim().trim('/').split("/")
-            url["raw"] = RequestUtils.contractPath(url.getAs("host"), path)
+            url["raw"] = RequestUtils.concatPath(url.getAs("host"), path)
             return listOf(item)
         }
     }
@@ -117,7 +116,7 @@ class PostmanFormatter {
 
         val path = pathInRequest.url() ?: ""
         url["path"] = path.trim().trim('/').split("/")
-        url["raw"] = RequestUtils.contractPath(url.getAs("host"), path)
+        url["raw"] = RequestUtils.concatPath(url.getAs("host"), path)
         return item
     }
 

diff --git a/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/yapi/YapiFormatter.kt b/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/api/export/yapi/YapiFormatter.kt
@@ -331,7 +331,7 @@ open class YapiFormatter {
             item["req_body_form"] = EMPTY_ARR
 
             //todo:need desc of body
-            item["req_body_other"] = parseBySchema(request.body, "")
+            item["req_body_other"] = parseBySchema(request.body, request.bodyAttr)
         }
 
         if (!request.response.isNullOrEmpty()) {

diff --git a/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/dialog/ApiCallDialog.kt b/idea-plugin/src/main/kotlin/com/itangcent/idea/plugin/dialog/ApiCallDialog.kt
@@ -13,10 +13,7 @@ import com.intellij.util.ui.ComboBoxCellEditor
 import com.itangcent.common.kit.KitUtils
 import com.itangcent.common.kit.notNullOrEmpty
 import com.itangcent.common.logger.traceError
-import com.itangcent.common.model.FormParam
-import com.itangcent.common.model.Request
-import com.itangcent.common.model.getContentType
-import com.itangcent.common.model.hasBody
+import com.itangcent.common.model.*
 import com.itangcent.common.utils.appendlnIfNotEmpty
 import com.itangcent.common.utils.notNullOrBlank
 import com.itangcent.common.utils.notNullOrEmpty
@@ -291,7 +288,8 @@ class ApiCallDialog : JDialog() {
                 }
 
         autoComputer.bind(this.pathTextField!!)
-                .from(this, "this.currRequest.path")
+                .with<URL>(this, "this.currRequest.path")
+                .eval { it.url()?:"" }
 
         autoComputer.bindVisible(this.paramPanel!!)
                 .with(this::currRequest)