api开发文档范例
内容要求 1. 文档标题 必须做到见文知意,通过标题名称就能大致知道这个接口的功能 2. 接口地址 只写域名后面的部分即可。如,/api/user/login 3. 请求方式 根据实际情况确定,但不能随意。提交数据用POST,获取数据用GET。 用户令牌的参数名固定为token。 4. 参数说明 须注明参数名,是否为空,参数类型,说明。后端须实现对是否为空,参数类型的判断。 5. 返回示例 至少有一个成功的返回示例。 6. 返回值说明 同“参数说明”。
用户评论