什么是REST API

  • REST (Representational Status Transfer) API
  • REST是一种设计风格,不是任何架构标准
  • 当今RESTful API通常使用HTTP作为通信协议,JSON作为数据格式

api设计的特点

  • 统一接口(Uniform Interface)
  • 无状态(Stateless
  • 可缓存(Cacheable)
  • 分层(Layered System)
  • CS模式(Client-server Atchitecture)

api设计的原则

  • 以URL(统一资源定位符)风格设计API
  • 通过不同的METHOD(GET,POST,PUT,DELETE)来区分对资源的 CRUD
  • 返回码(Status Code)符合HTTP资源描述的规定

本项目API设计

用户API设计

  • 创建(注册)用户:URL:/user Method:POST,SC:201,400,500
  • 用户登录:URL:/user/:username Method:POST,SC:200,400, 500
  • 获取用户基本信息:URL:/user/:username Method:GET,SC:200, 400, 401, 403, 500
  • 用户注销:URL:/user/:username Method:DELETE,SC:204,400, 401, 403, 500
Logo

CSDN联合极客时间,共同打造面向开发者的精品内容学习社区,助力成长!

更多推荐