参数名称 | 参数描述 | 示例值 |
API版本号 | API的版本号,用于标识不同的API接口 | v1.0 |
API发布日期 | API的发布日期,用于标识API的稳定性和兼容性 | 20220101 |
API更新日期 | API的最近更新日期,用于标识API的最新功能和修复的问题 | 20220501 |
API文档链接 | API的官方文档链接,用于查看API的详细说明和使用方法 | https://api.example.com/docs |
API支持的语言 | API支持的语言,用于标识API的多语言支持能力 | 中文、英文 |
API请求方法 | API支持的请求方法,用于标识API的访问方式 | GET、POST、PUT、DELETE |
API请求参数 | API的请求参数,用于标识API的输入参数和格式 | {“param1”: “value1”, “param2”: “value2”} |
API响应参数 | API的响应参数,用于标识API的输出结果和格式 | {“result”: “success”, “data”: {“key1”: “value1”, “key2”: “value2”}} |
API错误码 | API的错误码,用于标识API的错误类型和原因 | 400(Bad Request)、401(Unauthorized)、500(Internal Server Error) |
API错误信息 | API的错误信息,用于标识API的错误提示和解决方法 | “Invalid parameter value”、”Authentication failed”、”Internal server error” |