用REST风格设计博客API

最新推荐文章于 2021-09-06 15:46:29 发布
最新推荐文章于 2021-09-06 15:46:29 发布
阅读量199 收藏
点赞数 1
分类专栏： 学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/leaff_/article/details/103206825
版权

一. 作业内容

模仿 Github，设计一个博客网站的 API

二. 博客API设计

1. 针对个人博客时：

1) 获取自己博客下的所有文章
GET /api/v1/user/articles

查看文章时，使用GET方法。这里用单数user指代自己一个人且不用指定自己用户名或者id。v1代表版本号。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
2) 根据文章id获取自己的文章
GET /api/v1/user/articles/:id

这里把文章名，即:（article）id看作是层级数据。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
3) 获取自己某主题分类下的所有文章
GET /api/v1/user/articles/topics

其中，topics表示主题类型。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
4) 创建文章
POST api/v1/user/articles

创建新的文章时，采用POST方法。用单数user指代自己一个人，不用指定自己用户名或者id。其中user是主资源，article是子资源。

响应内容
HTTP/1.1 201 CREATED
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 400 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
5) 修改文章
PUT api/v1/user/articles/:id

修改一篇文章时，采用PUT方法。因为只能用户自己修改，所以只需要层次数据:id来指明要修改的文章。用单数user指代自己一个人，不用指定自己用户名或者id。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 409 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
6) 删除文章
DELETE api/v1/user/articles/:id

删除一篇文章时，采用DELETE方法。和修改时一样，因为只能用户自己删除文章，所以只需要层次数据:id来指明要修改的文章。用单数user指代自己一个人，不用指定自己用户名或者id。

响应内容
HTTP/1.1 204 NOT CONTENT
{
    "count":100,
    "items":[
        {
        },
        ...
    ]
}

失败响应
HTTP/1.1 404 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "NOT_FOUND",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
2. 针对所有用户博客时：
1) 获取指定用户的所有文章
GET api/v1/users/:username/articles

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}

查看文章时，使用GET方法。这一条对比上面几条，user改为了users，指代所有用户。:username是层次数据，指特定用户，是唯一的。articles指该用户的所有文章。

2) 根据用户以及文章id获取具体文章
GET api/v1/users/:username/articles/:id

:username和:id是层次数据，其中，:username指特定用户，是唯一的。articles指该用户的所有文章。:id指文章中的某一特定文章编号，也是唯一的。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
3) 根据用户和主题获取某用户某主题分类下的所有文章
GET api/v1/users/:username/articles/topics

这里和上面一条不同之处在于不是要获得该用户博客下的某一特定文章，而是要获得该用户博客下的某一特定主题文章，所以用topics而不用:id。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 403 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}

3. 用户验证：

1) 验证方式
curl -u "username" https://api.blog.com

其中的https://api.blog.com表示博客网址。

2) 登录失败返回的错误信息
使用无效的凭据进行身份验证将返回401 Unauthorized：
curl -i https://api.blog.com -u foo:bar
HTTP/1.1 401 Unauthorized
{
  "message": "Bad credentials",
  "documentation_url": "https://developer.blog.com/v3"
}
在短时间内检测到多个具有无效凭据的请求后，API会临时拒绝该用户的所有身份验证尝试（包括具有有效凭据的请求）403 Forbidden：
curl -i https://api.blog.com -u valid_username:valid_password
HTTP/1.1 403 Forbidden
{
  "message": "Maximum number of login attempts exceeded. Please try again later.",
  "documentation_url": "https://developer.blog.com/v3"
}
3) 用户修改密码
PUT  api/v1/users/:username/password/actions/modify

因为“密码修改”这个接口的命名很难完全使用名词来构建路径，所以引入了action命名。

响应内容
HTTP/1.1 200 OK
{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "password": 1496676420000,
            ...
        },
        ...
    ]
}

失败响应
HTTP/1.1 409 UC/AUTH_DENIED
Content-Type: application/json
{
    "code": "INVALID_ARGUMENT",
    "message": "{error message}",
    "cause": "{cause message}",
    "request_id": "01234567-89ab-cdef-0123-456789abcdef",
    "host_id": "{server identity}",
    "server_time": "2019-11-22T22:07:00Z"
}
leaff_
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
博客API
02-09
在这个项目中，我们将探讨使用Node.js、MongoDB、Express.js和JavaScript构建一个简单的博客API。 **Node.js** 是一个基于Chrome V8引擎的JavaScript运行环境，它让开发者可以在服务器端使用JavaScript编写代码，为...
这份 HTTP API 设计指南，建议收藏！
架构文摘
04-19 334
返回合适的状态码为每一次的响应返回合适的HTTP状态码. 成功的HTTP响应应该使用如下的状态码:200: GET请求成功, 以及DELETE或 PATCH 同步请求完成201: POST 同步请求完成202: POST, DELETE, 或 PATCH 异步请求将要完成206: GET 请求成功, 这里只是一部分状态码: 更多对于用户请求的错误情况，及服务器的异常错误情...
WordPress REST API 主题
你的北音
09-06 208
介绍： 主题特色： 使用Nuxtjs + WordPress Rest Api 实现前后端分离，可完成多端部署； 主题支持自动切换黑夜模式。 使用说明： service 目录为wordpress主题文件，需要拷贝到wordpress主题目录下，wp-content/themes 使用的时候请修改 nuxt.config.js 的配置项，改为自己的信息，修改注释的地方即可 修改 assets/scss/variable.scss 文件下的 $color-theme 变量，可以更换博客的主体风格
blog-api::memo:博客REST API
03-18
REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，它基于HTTP协议，通过URL定位资源，使用HTTP方法（GET、POST、PUT、DELETE等）来操作资源。在Java领域，实现RESTful API最常用的...
nodejs-restapi-example::hot_springs:开源NodeJs RestAPI
05-19
- **RESTful API**: RESTful API 是遵循 REST 架构约束条件和原则的 API 设计方式。它将资源以 URI（Uniform Resource Identifier）表示，通过 HTTP 方法进行操作，以 JSON 或 XML 格式交换数据。 **2. 主要技术栈*...
nodejs-mysql:使用node.js和MySQL的教程博客文章的存储库。 它具有使用Express js构建的引号REST API
05-09
它包含了用Express.js创建的“引号REST API”，这表明我们可以在此项目中学习到如何构建基于RESTful架构风格的应用程序接口。 **Node.js与MySQL的集成** Node.js是一种基于Chrome V8引擎的JavaScript运行环境，允许...
Rosetta.RestApi
06-02
REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，常用于构建Web服务，强调资源的表述和状态转换。 在Java世界中，开发REST API通常会用到如Spring Boot这样的框架，但Rosetta....
使用 React 和 Redux 进行井字游戏并附带源代码.zip
07-24
项目：使用 React 和 Redux 进行井字游戏并附带源代码 使用 react 和 redux 的井字游戏是一个简单的 react 项目。整个项目都是使用 react components 和redux制作的。游戏很简单，玩法也很多。要运行此项目，您必须先安装 NodeJS。 关于项目 井字游戏反应而 redux 是使用ReactJS开发的。说到这个游戏，它具有高级功能和游戏玩法。要运行此项目，首先，您必须安装费用到您的系统。然后运行npm安装然后开始运行npm开始。游戏启动后，您可以选择不同的游戏选项。您还可以选择所需的网格框数量。此外，您还可以选择对手的类型。 要运行此项目，您需要 在计算机上安装NodeJS 并使用现代浏览器，例如 Google Chrome、  Mozilla Firefox。 演示： 该项目为国外大神项目，可以作为毕业设计的项目，也可以作为大作业项目，不用担心代码重复，设计重复等，如果需要对项目进行修改，需要具备一定基础知识。 注意：如果装有360等杀毒软件，可能会出现误报的情况，源码本身并无病毒，使用源码时可以关闭360，或者添加信任。
使用 JavaScript 编写的专注力游戏（附源代码）.zip
07-24
项目：JavaScript 中的专注力游戏（附源代码） 专注力游戏是一个使用 JavaScript、CSS 和 HTML 开发的简单项目。这款游戏很有趣。玩家必须点击移动的框并获得分数。要点击正确的位置，玩家需要在这个游戏中集中注意力。这款游戏可以帮助玩家练习以进一步增强他们的专注力。 游戏制作 这个游戏项目仅使用 HTML、CSS 和 JavaScript。说到这个游戏的特点，用户必须单击移动框并得分。游戏有三种模式：简单、中等和困难。游戏的 PC 控制非常简单。您只需使用光标单击移动框的碎片即可。 该游戏包含大量的 javascript 以确保游戏正常运行。 如何运行该项目？ 要运行此游戏，您不需要任何类型的本地服务器，但需要浏览器。我们建议您使用现代浏览器，如 Google Chrome 和 Mozilla Firefox。要玩游戏，首先，单击 index.html 文件在浏览器中打开游戏。 演示： 该项目为国外大神项目，可以作为毕业设计的项目，也可以作为大作业项目，不用担心代码重复，设计重复等，如果需要对项目进行修改，需要具备一定基础知识。 注意：如果装有360等杀毒软件，可能会出现误报的情况，源码本身并无病毒，使用源码时可以关闭360，或者添加信任。
人脸识别方案资料61EDA-C1590.zip
07-24
人脸识别方案资料61EDA_C1590.zip
316、基于DK124设计的离线式开关电源设计12V 2A（原理图、PCB图、BOM表、设计说明）
07-24
316、基于DK124设计的离线式开关电源设计12V 2A（原理图、PCB图、BOM表、设计说明） 该设计为DK124控制的开关电源，实现12V 2A输出； 功能： 1、使用DK124核心控制； 2、反激式开关电源拓扑设计； 3、实现12V 2A输出； 4、市电输入； 5、整流、滤波、变压器等电路； 6、原理图、PCB图、BOM表、设计说明；
基于Springboot和Vue的生鲜超市管理的设计与实现源码 生鲜超市管理的设计与实现代码（优秀毕业设计）
07-24
生鲜超市管理的设计与实现源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！ 系统源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！ 系统源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！
使用 ReactJs 编写的简单旅行计划器（附源代码）.zip
07-24
项目：使用 ReactJS 编写的简单旅行计划器（附源代码） ReactJs 中的简单旅行计划器是一个简单的 JavaScript 项目。该项目是 ReactJS 中待办应用程序的一个简单示例。 关于项目 Simple Trip Planner In Reactjs 是使用ReactJS开发的。这个项目很容易做一种应用程序。这个项目使用 React 库来完成任务。为了运行这个项目，你必须在系统中安装 NodeJs。当你运行这个项目时，你的应用程序从主页开始。从那里你可以导航到菜单。你只能将计划添加到你的书中。你还可以对旅行进行分类。你所要做的就是输入日期和地点，然后选择你想要的旅行计划类型。 要运行此项目，您需要 在计算机上安装ReactJS和 NodeJs，并使用现代浏览器，例如Google Chrome、  Mozilla Firefox。 演示： 该项目为国外大神项目，可以作为毕业设计的项目，也可以作为大作业项目，不用担心代码重复，设计重复等，如果需要对项目进行修改，需要具备一定基础知识。 注意：如果装有360等杀毒软件，可能会出现误报的情况，源码本身并无病毒，使用源码时可以关闭360，或者添加信任。
俄罗斯方块的python代码
07-24
这段Python代码实现了一个简单的俄罗斯方块游戏，使用Pygame库处理图形和用户输入。游戏初始化Pygame库并设置屏幕大小为800x600像素，定义不同颜色和形状的方块。游戏由一个`Tetris`类管理，负责游戏状态和逻辑操作，每个方块由一个`Block`类表示，包含其形状、颜色、位置等信息。 在主循环中，游戏通过事件处理机制响应用户的键盘输入，箭头键用于移动和旋转方块，空格键用于快速下落。游戏会检测方块是否与已有的方块或边界发生碰撞，如发生碰撞，当前方块会固定在场地上并生成新方块。填满的行会被清除，玩家获得相应分数。 游戏通过一个二维数组维护场地状态，每个元素表示一个单元格是否被占据，通过检查和清除单元格实现行消除。整个游戏不断刷新屏幕更新显示，确保流畅运行，绘制背景、方块和边框，使界面美观易理解。 总体而言，这段代码展示了如何使用Pygame库实现经典俄罗斯方块游戏，包括图形绘制、用户输入处理和基本游戏逻辑，让玩家通过移动和旋转方块消除行并获得高分。
绿色金融：“双碳”经济时代，银行业务增长新引擎-埃森哲(
07-24
绿色金融：“双碳”经济时代，银行业务增长新引擎-埃森哲(
基于Springboot和Vue的结合疫情情况的婚恋系统源码 结合疫情情况的婚恋系统代码（高分毕设）
07-24
结合疫情情况的婚恋系统源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！ 系统源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！ 系统源码（高分毕设），个人经导师指导并认可通过的98分毕业设计项目，主要针对计算机相关专业的正在做毕设的学生和需要项目实战练习的学习者。也可作为课程设计、期末大作业。包含全部项目源码[代码]、该项目可以直接作为毕设使用。项目技术栈：前端是vue，后端是springboot，项目代码都经过严格调试，代码没有任何bug！
人脸识别方案资料61EDA-C1618.zip
07-24
人脸识别方案资料61EDA_C1618.zip
精美且实用的Web页面设计模板
07-24
在网页设计领域，Web页面模板是一种预先设计好的布局框架，用于快速构建网站并提供一致的视觉体验。"很实用很漂亮的web页面模板"这个标题暗示了我们正在讨论的是一套高效且美观的模板，适用于那些希望节省时间并创造专业外观网站的设计师或开发者。 描述中的“全部使用的div+css”表明这些模板基于HTML的结构元素`div`和层叠样式表(CSS)进行构建。`div`元素是HTML中最常用的一种容器，可以用来组合、分组其他HTML元素，方便通过CSS进行样式控制和布局管理。CSS则负责定义网页的样式，如颜色、字体、布局以及响应式设计，使网页在不同设备上展示效果良好。 我们要理解Div+CSS布局的优势。传统的表格布局在复杂性和可维护性上往往不如Div+CSS。使用Div+CSS，我们可以实现更清晰的代码结构，提高页面加载速度，同时提供更好的搜索引擎优化（SEO），因为搜索引擎更容易解析结构化的HTML代码。 模板中的每个页面通常会包含头部、导航、主体、侧边栏和页脚等部分，这些都可能由`div`元素定义。CSS将用于设定这些区域的样式，包括它们的大小、位置、背景、边框等。通过浮动（floa
IMG20240603155230.jpg
最新发布
07-24
IMG20240603155230.jpg
遵循Web标准的REST API设计法则：Mark Massé指南
《REST API设计守则》是一本由Mark Massé编写的实用指南，旨在帮助开发者在日益竞争激烈的Web服务市场中打造高质量的RESTful API。本书围绕REST架构风格的最佳实践，提供了一系列精心设计的规则，包括URI设计、HTTP...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值