YesDev
HTTP/HTTPS
请求协议
YesDev / WebAPI / 更新api文档
更新api文档
接口地址：https://www.yesdev.cn/api/platform.php?s=Platform.ApiDocument_ApiDocument.UpdateApiDocument
接口描述： 更新api文档
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| app_key | 字符串 | 可选 | app_key，团队代码 | ||
| sign | 字符串 | 可选 | - | 动态签名，签名算法请联系我们技术客服获取 | |
| id | 整型 | 必须 | - | api文档id | |
| document_cate_id | 整型 | 必须 | - | 文档分类id | |
| api_service_title | 字符串 | 必须 | - | 接口服务标题 | |
| api_service_url | 字符串 | 可选 | 接口服务url | ||
| api_service_request_type | 字符串 | 可选 | GET | 接口请求类型 | |
| api_status | 字符串 | 可选 | 0 | 接口状态 | |
| api_service_desc | 字符串 | 可选 | 接口服务描述 | ||
| simulation_data | 字符串 | 可选 | 模拟接口数据 | ||
| use_common_api_head | 字符串 | 可选 | 0 | 使用公共api请求头 | |
| use_common_api_params | 字符串 | 可选 | 0 | 使用公共api请求参数 | |
| use_common_api_return | 字符串 | 可选 | 0 | 使用公共api响应参数 | |
| use_common_api_error_code | 字符串 | 可选 | 0 | 使用公共错误码 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| app_key | 可选 | |
| sign | 可选 | |
| id | 必须 | |
| document_cate_id | 必须 | |
| api_service_title | 必须 | |
| api_service_url | 可选 | |
| api_service_request_type | 可选 | |
| api_status | 可选 | |
| api_service_desc | 可选 | |
| simulation_data | 可选 | |
| use_common_api_head | 可选 | |
| use_common_api_params | 可选 | |
| use_common_api_return | 可选 | |
| use_common_api_error_code | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/Platform.ApiDocument_ApiDocument.UpdateApiDocument.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 410 | 权限不足 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-27 17:20:57 联系我们开通接入OpenAPI