设计一个REST API

这篇博客将主要描绘一个简单的博客网站的API,基于HTTP,换句话说就是,RESTful HTTP。数据本体和返回请求都是通过JSON进行的。

用户管理

用户管理通过向/user发送请求进行。支持的如下

目标方法效果其他
/userGET获取用户列表最大限制50个,使用?limit=&offset=来调整
/userPOST创建新用户需要在请求正文包含usernamepassword
/user/{username}GET获取用户详细信息username不存在,返回HTTP 404
/user/{username}PUT更新用户信息请求正文包含要更改的字段和密码确认,也可能返回404
/user/{username}DELETE删除用户请求正文需要用户密码确认,也可能返回404
/user/{username}/articlesGET获取该用户发布的文章最大限制50个,使用?limit=&offset=来调整,返回文章ID列表
/user/{username}/articlesPOST以该用户身份发布文章请求正文包含用户密码、文章标题和正文信息

文章管理

文章管理通过向/article发送请求进行。支持的如下

目标方法效果其他
/articleGET获取全站文章列表最大限制50个,使用?limit=&offset=来调整
/articlePOST发布新文章需要用户名和密码来指定发布者身份,还需要提供文章标题和正文内容
/article/{id}GET获取文章内容不光返回文章内容,还返回用户名。若id不存在,返回HTTP 404
/article/{id}PUT修改文章内容需要用户密码确认,包含要更改的内容,可能返回404
/article/{id}DELETE删除文章需要用户密码确认,可能返回404

其他

目标方法效果其他
/GET获取可用API列表
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值