这篇博客将主要描绘一个简单的博客网站的API,基于HTTP,换句话说就是,RESTful HTTP。数据本体和返回请求都是通过JSON进行的。
用户管理
用户管理通过向/user
发送请求进行。支持的如下
目标 | 方法 | 效果 | 其他 |
---|---|---|---|
/user | GET | 获取用户列表 | 最大限制50个,使用?limit=&offset= 来调整 |
/user | POST | 创建新用户 | 需要在请求正文包含username 和password |
/user/{username} | GET | 获取用户详细信息 | 若username 不存在,返回HTTP 404 |
/user/{username} | PUT | 更新用户信息 | 请求正文包含要更改的字段和密码确认,也可能返回404 |
/user/{username} | DELETE | 删除用户 | 请求正文需要用户密码确认,也可能返回404 |
/user/{username}/articles | GET | 获取该用户发布的文章 | 最大限制50个,使用?limit=&offset= 来调整,返回文章ID列表 |
/user/{username}/articles | POST | 以该用户身份发布文章 | 请求正文包含用户密码、文章标题和正文信息 |
文章管理
文章管理通过向/article
发送请求进行。支持的如下
目标 | 方法 | 效果 | 其他 |
---|---|---|---|
/article | GET | 获取全站文章列表 | 最大限制50个,使用?limit=&offset= 来调整 |
/article | POST | 发布新文章 | 需要用户名和密码来指定发布者身份,还需要提供文章标题和正文内容 |
/article/{id} | GET | 获取文章内容 | 不光返回文章内容,还返回用户名。若id 不存在,返回HTTP 404 |
/article/{id} | PUT | 修改文章内容 | 需要用户密码确认,包含要更改的内容,可能返回404 |
/article/{id} | DELETE | 删除文章 | 需要用户密码确认,可能返回404 |
其他
目标 | 方法 | 效果 | 其他 |
---|---|---|---|
/ | GET | 获取可用API列表 | 无 |