easyopen_template.markdownDoc.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of easyopen Show documentation

一个简单易用的接口开放平台，平台封装了常用的参数校验、结果返回等功能，开发者只需实现业务代码即可。https://gitee.com/durcframework/easyopen

There is a newer version: 1.16.20

#set($jin="#")

$jin ${docItem.description}

---

#if("$!{docItem.remark}" != "")
${docItem.remark}
#end


    
        接口名
        ${docItem.name}
        版本号
        ${docItem.version}
    


**请求参数**


    #foreach($paramDefinition in ${docItem.paramDefinitions})
    ${paramDefinition.paramMarkdownHtml}
    #end

    
        名称
        类型
        是否必须
        最大长度
        示例值
        描述
    

**参数示例**

```json
${docItem.paramData}
```

**返回结果**


    #if(${docItem.singleReturn})
        
    #else
    
    #end

    
        名称
        类型
        描述
    
    
        code
        string
        状态值，"0"表示成功，其它都是失败
    
    
        msg
        string
        错误信息，出错时显示
    

            data
            ${docItem.apiDocReturnDefinition.dataType}
            ${docItem.apiDocReturnDefinition.description}。#if(${docItem.apiDocReturnDefinition.example} != "")示例值：${docItem.apiDocReturnDefinition.example}#end
        

        data
        object
        返回的数据，没有则返回{}
            
                #foreach($resultDefinition in ${docItem.resultDefinitions})
                ${resultDefinition.resultHtml}
                #end
            
                
                    名称
                    类型
                    最大长度
                    示例值
                    描述
                
        
    

**返回示例**

```json
${docItem.resultData}
```