RESULT风格的API接口设计

  • 使用https替代http

  • 使用二级域名 api.test.com

  • 使用版本号 (便于调用者更新)

  • http动词(资源的操作)

    • 获取 get

    • 创建 post

    • 修改 put

    • 删除 del

  • 返回状态码和状态信息

    • 500 服务器内部错误

    • 404 网页丢失

    • 有权限,但被禁止访问

    • 没有权限

  • 使用常用参数来过滤数据

    • offset 指定返回记录开始的位置

    • limit 指定返回记录的数量

    • page 指定第几页

    • per_page 每页多少记录数

  • 安全因素:

    • 根据用户访问,生成访问令牌

    • 使用白名单 黑名单[ip、域名、url],指定某些IP只能访问/不能访问我们API

    • 请求频率、设备、终端浏览器

    • 生成接口文档

特别感谢

参考博客:

本作品采用《CC 协议》,转载必须注明作者和本文链接
EMin
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!