# 介紹
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
這里填寫錯誤的返回碼
以此類推,每個狀態使用 <<< 分割,
第一行添加狀態名稱
~~~