# 介绍
APi文档
## 参数说明规范
通常先说明含义,然后后面`()`为默认值,默认值中的`{{变量}}`为必须修改的变量;例如:
参数({“filter“:{“type“:1,“expressions“:{“dataType“:6,“left“:“id“,“op“:1,“title“:“租户ID“,“right“:“{{用户租户ID}}“}}})
说明这是一个参数,参数的默认值是 `{“filter“:{“type“:1,“expressions“:{“dataType“:6,“left“:“id“,“op“:1,“title“:“租户ID“,“right“:“{{用户租户ID}}“}}}`, 其中`用户租户ID`为变量,使用是必须修改成对应的变量
## 示例
~~~[api]
get:/url
*id=默认值#说明文字
name#说明文字
<<<
success
{
"errNum": 0,
"retMsg": "success",
"retData": {}
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
~~~