休息端点结构

时间:2016-11-25 15:46:32

标签: rest restful-architecture restful-url api-design httpverbs

假设我有要求:

  • 通过电子邮件注册
  • 通过社交网络注册
  • 通过电子邮件登录
  • 通过社交网络登录
  • 注销
  • 获取我的个人资料
  • 编辑我的个人资料
  • 获取一些用户个人资料
  • 列出我的朋友
  • 列出一些用户朋友
  • 邀请社交网络的朋友
  • 添加产品
  • 修改产品
  • 搜索产品
  • 列出我的产品
  • 列出一些用户产品

端点REST API结构应该如何?

1 个答案:

答案 0 :(得分:0)

总是问问自己:

  

我的资源是什么?

  • 通过电子邮件注册POST /api/registration
  • 按社交网络注册POST /api/providerRegistration
  • 获取一些用户个人资料GET /api/user?userId={userId}
  • 列出我的朋友GET /api/friends
  • 列出一些用户朋友GET /api/friends?userId={userId}
  • 添加产品POST /api/product
  • 修改产品PUT/PATCH /api/product/{productId}
  • 搜索产品GET /api/products?status={status}
  • 列出我的产品GET /api/products?userId={userId}

等等 - 你得到了它的要点。请注意,路径(REST资源)是名词(product),而不是动词(search)。