更新文档
POST
https://easydoc.net/openapi/v1/updateDocs
接口描述
开放接口，更新指定项目的 http 文档
请求头
参数名
类型
描述
必填
Content-Type
string
application/json
必填
请求参数
参数名
类型
描述
必填
apikey
string
APIKEY，接口调用凭证，在官网-个人中心-APIKEY获取。示例：LDbXkh4kP9Uo273X3rZqWt7SoFPeySuB
必填
branchId
string
分支ID，文档编辑页，地址栏的最后一段编码
必填
title
string
文档标题，支持多层级目录，用斜杠分隔，例如：/app/聊天模块/获取好友
必填
url
string
请求URL,示例：/api/regist
必填
desc
string
接口简述
必填
method
string
请求方法，示例：POST
必填
name
string
参数名，示例：token
必填
type
string
参数类型，示例：string
必填
required
boolean
是否必须，示例：true
必填
desc
string
参数描述，示例：登录成功后获取到的token
必填
children
array[object]
子参数列表，结构跟headers是一样的，没有的话可以不传递，或者传递空数组
可选
params
array[object]
请求参数列表，结构跟 headers 参数一样
可选
response
array[object]
响应参数列表，结构跟 headers 参数一样
可选
markdown
string
填充到文档的 ”说明 / 示例“ 块的内容，markdown格式
可选
响应参数
参数名
类型
描述
必填
code
number
错误码，0表示成功，小于0表示有错，会在msg字段告诉你错误原因。示例：0
必填
msg
string
错误提示信息，示例：success
可选