获取接口的请求参数与返回参数 - Admin.TestSample.GetReqAndResParams - 接口大师

接口地址：https://13520.site/api/admin.php?s=Admin.TestSample.GetReqAndResParams

接口描述：获取某个参数的请求参数和返回参数

HTTP/HTTPS

请求协议

GET/POST

请求方式

UTF-8

编码格式

JSON

返回格式

接口参数

参数名字	类型	是否必须	默认值	其他	说明
access_token	字符串	可选			访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
api_name	字符串	必须	-		接口名称

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.code	bool	获取状态
data.msg	字符串	获取的信息
data.requestParams	字符串	接口请求参数，包括（name名字 require是否必须 desc描述）
data.responseParams	字符串	接口返回参数，包括（type类型 name名字 desc描述）
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
api_name	必须

客户端请求示例

{
    "ret": 200,
    "data": {
        "code": true,
        "msg": "获取成功",
        "requestParams": {
            "appKey": {
                "name": "app_key",
                "required": "必须",
                "desc": "app_key，用于区分客户端应用"
            },
            "appSecret": {
                "name": "app_secret",
                "required": "必须",
                "desc": "应用密钥"
            },
            "accessToken": {
                "name": "access_token",
                "required": "可选",
                "desc": ""
            },
            "uid": {
                "name": "uid",
                "required": "可选",
                "desc": "授权的用户id，如果用户已登录可加传此参数，以便后续服务端判断用户是否已登录"
            }
        },
        "responseParams": {
            "access_token": {
                "name": "access_token",
                "type": "string",
                "desc": "新的访问令牌，申请失败时返回空字符串"
            },
            "expire_at": {
                "name": "expire_at",
                "type": "int",
                "desc": "过期时间戳"
            }
        }
    },
    "msg": ""
}

错误列表

错误状态码	错误描述信息
400	ret=400，客户端参数错误或非法请求
404	表示接口服务不存在
406	ret=406，access_token令牌校验不通过
407	ret=407，app_key权限不足，或未知应用
408	ret=408，当前用户禁止使用，或用户未登录
500	表示服务端内部错误

本文档生成时间：2025-01-16 22:06:37