博客网站REST API设计

最新推荐文章于 2022-04-11 20:29:21 发布
最新推荐文章于 2022-04-11 20:29:21 发布
阅读量363 收藏 1
点赞数
分类专栏： 作业
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Zqz983944/article/details/103160180
版权

博客网站REST API设计

主要功能：

用户注册

Request

POST /api/v1/users

Input

nametypedescription
usernamestringname of the signing user
passwordstringpassword
captchaIDstringID of the captcha
captchaCodestringCode of the identifaction
{
	"username": "Zhangqzh"
	"password": "Zhangqzh",
	"captcha_id": "You have got a captcha ID",
	"captcha_code": "Response",
	"created_at": "2019-11-20T00:00:00Z"
}

Response

Status: 201 Created

Location: /api/v1/users

{
  "id": 1
  "user_name": "Zhangqzh",
  "created_at": "2019-11-20T00:00:00Z"
}

用户登陆

Request

POST /api/v1/users/login

Input

nametypedescription
usernamestringname of the signing user
passwordstringpassword
captchaIDstringID of the captcha
captchaCodestringCode of the identifaction
{
	"username": "Zhangqzh"
	"password": "Zhangqzh",
	"captcha_id": "You have got a captcha ID",
	"captcha_code": "Response",
	"created_at": "2019-11-20T00:00:00Z"
	"updated_at": "2019-11-20T01:00:00Z"
}

Response

Status: 201 OK

Location: /api/v1/users

{
	"access——token": "token...",
	"expires_in": 3600
}

Failed login limit

验证无效的凭据将返回401未经授权:
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禁止
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"
}

获取分类列表

Request

GET /api/v1/categories

Input

nametypedescription
pagenumberpage number
sizenumbersize of page

Response

Status: 200 OK
Location: /api/v1/categories

{
 "categories"[
{
	"id": "0", //id
	"node_id": "MDEwOlJlcG9zaXRvcnkxOTE0MzIzMjE=",//node id
    "name": "Go语言学习", //分类名称
    "count": 10 // 文章数
}]
}

创建分类列表

Request

POST /api/v1/categories

Input

nametypedescription
namestrinfname of category

{
“name”: “3D unity”
}

Response

Status: 201 Created
Location: /api/v1/categories


{
    "id": 1,
    "name": "3D unity"
}

注意：必须添加权限验证,否则返回401 Unauthorized

更新分类列表

Request

PUT /api/v1/categories/:category_id

Input

nametypedescription
category_namestringname of category
{
    "name": "3D unity"
}

Response

Status: 200 OK
Location: /api/v1/categories/0

{
    "id": 1,
    "name": "3D unity"
    "message": "update from ",
    "content": "Y3JlYXRlIGZpbGUgZnJvbSBJTlNPTU5JQQoKSXQncyB1cGRhdGVkISEhCgpJdCdzIHVwZGF0ZWQgYWdhaW4hIQ==",
}

注意：必须添加权限验证,否则返回401 Unauthorized

删除分类

Request

DELETE /api/v1/categories:category_id

Input

nametypedescription
category_namestringname of category
{
    "name": "3D unity"
}

Response

Status: 204 No Content
Location: /api/v1/categories/0

{
  "message": "delete a category",
}

注意：必须添加权限验证,否则返回401 Unauthorized

获取分类内的文章

Request

GET /api/v1/categories/:category_id

Input

nametypedescription
pagenumberpage number
sizenumbersize of page

Response

Status: 200 OK
Location: /api/v1/categories/0

{
    "category": "Go 语言学习",
    "articles": [
        {
            "id": 0,
            "title": "源码学习-net/http",
            "created_at": "2019-11-11T00:00:00Z"
        },
        {
            "id": 1,
            "title": "阅读《Golang web应用开发》",
            "created_at": "2019-11-05T00:00:00Z"
        }
    ]
    ...
}

获取某个文章

Request

GET /api/v1/articles/:article_id

Response

Status: 200 OK
Location: /api/v1/articles/0

{
    "id": 0,
    "category_id": 0,
    "category_name": "Go 语言学习",
    "article_title": "源码学习-net/http",
    "article_content": "*****"
}

创建新文章

Request

POST /api/v1/articles

Input

nametypedescription
catagory_idnumberid of category
article_titlestringtitle of article
contentstringcontent of article
{
    "category_id": 0,
    "article_id": 2,
    "title": "博客网站REST API设计",
    "content": "*****"
}

Response

Status: 201 Created
Location: /api/v1/articles

{
    "categoryId": 0,
    "article_id": 2,
    "title": "博客网站REST API设计",
    "content": "*****"
    "size" : "*****"
    "created_at":"2019-11-20T00:00:00Z"
    "url": "https://api.blog.com/repos/go-"
}

注意：1. 必须添加权限验证,否则返回401 Unauthorized 2. 数据传送格式选择JSON 3. 文件内容必须是把文件整体转为Base64字符串再存到JSON变量中

更新文章

Request

PUT /api/v1/articles/:article_id

Input

nametypedescription
catagory_idnumberid of category
article_titlestringtitle of article
contentstringcontent of article
{
    "category_id": 0,
    "article_id": 2,
    "title": "博客网站REST API设计",
    "content": "*****"
}

Response

Status: 200 OK
Location: /api/v1/articles/3

{
    "categoryId": 0,
    "article_id": 2,
    "title": "博客网站REST API设计",
    "content": "*****"
    "size" : "*****"
    "created_at":"2019-11-20T00:00:00Z"
    "updated_at":"2019-11-20T14:00:00Z"
    "url": "https://api.blog.com/repos/go-"
}

注意：必须添加权限验证,否则返回401 Unauthorized
对文件格式有要求，如果没有按照格式把上传时的json必填项输入，则会出现422错误信息：

{   
    "message": "Invalid request...",
    "url": "https://api.blog.com/repos/go-"
}

删除文章

Request

DELETE /api/v1/articles/:article_id

{   
    "message": "delete a file",
}

Response

Status: 204 No Content
Location: /api/v1/articles/1

{   
    "content": null,
    "url": "https://api.blog.com/repos/go-"
}

获取文章的评论

Request

GET /api/v1/articles/:article_id/comments

Input

nametypedescription
pagenumberpage number
sizenumbersize of page

Response

Status: 200 OK
Location: /api/v1/articles/

    {
        "id": "0",
        "user": {
            "id": 0,
            "username": "zz",
        },
        "content": "*****",
        "created_at": "2019-11-20T00:00:00Z"
    },

添加评论

Request

POST /api/v1/articles/:article_id/comments

Input

nametypedescription
contentstringcontent
{
    "content": "*****"
}
Response
Status: 202 Accepted
Location: /api/v1/articles/0/comments

{
    "id": "0",
    "article_title": "博客网站REST API设计"
    "content": "*****",
    "createdAt": "2019-11-19T00:00:00Z"
}
Zqz983944
关注
专栏目录
简单博客网站API设计
qq_20549085的博客
11-20 237
简单博客网站API设计 前言 这是中山大学数据科学与计算机学院2019年服务计算的作业项目。所有代码与博客将被上传至github当中。 Github项目地址: https://github.com/StarashZero/ServerComputing/tree/master/hw6 个人主页: https://starashzero.github.io 作业简介 模仿 Github，设计一个博客...
基于markdown的博客网站Rest API设计
agent0024的博客
11-19 398
本次作业基于markdown编写了一个模仿github api的rest api 数据架构 由于Http是唯一与REST相关的实例，本文的实现通过HTTP实现REST，所有的API访问基于HTTPS进行 访问博客网站的API，https://api.BlogExample.com来进行数据的访问，所有数据通过JSON形式进行发送和接收 资源是Restful API的核心元素，所有的操作...
设计并实现一个博客网站的REST API
WeiXiaoAssassin的博客
11-22 274
设计一个博客网站的REST API 要求：模仿 Github，设计一个博客网站的 API 规范：REST API 设计 Github API v3 overview；微软 文章目录设计一个博客网站的REST API[Github项目地址]( https://github.com/wywwwwei/ServiceComputingOnCloud/tree/master/HW6_RESTapi )...
博客网站的REST API设计
HaiRG的博客
11-19 406
博客网站的REST API设计作业题目要求REST API介绍设计一个博客网站的API获取用户所有的博客的摘要获得一篇文章的详细内容获得一篇文章的评论内容更新一篇文章发布一篇文章删除一篇文章获取某月文章认证登陆错误信息 作业题目 博客网站的REST API设计 要求 仿造github设计一个博客网站的REST API REST API介绍 REST是Representational State T...
博客api设计
penhison的博客
11-23 373
REST API for blog v0.1 前言 基于RESTful约定设计一个博客的api 本次设计的api用于开发环境，获取的不是网页，而是json格式的数据。 本次演示的博客api网址假设为https://api.blog.penhison.com/ api总览 描述 方法 地址 获取用户信息 GET /[username] 获取文章信息 GET /article/[i...
尝试设计一个博客网站API
Jundesky的博客
11-20 386
文章目录1. 前言2. REST简介3. 设计原则3.1 围绕资源组织 API3.2 根据HTTP方法定义操作3.3 使用一致的数据格式3.4 符合HTTP语义3.5 数据筛选和分页3.6 使用 HATEOAS 导航到相关资源4.设计博客网站的REST API4.1 登陆4.2 查看所有文章4.3 根据关键词查找文章 1. 前言 1.本博客目的是仿造github设计一个博客网站的REST API...
REST API 最佳实践 – REST 端点设计示例
m0_57290114的博客
04-11 3545
在 Web 开发中，REST API 在确保客户端和服务器之间的顺畅通信方面发挥着重要作用。 您可以将客户端视为前端，将服务器视为后端。 客户端（前端）和服务器（后端）之间的通信通常不是超级直接的。因此，我们使用一个称为应用程序编程接口（或API）的接口来充当客户端和服务器之间的中介。 由于 API 在这种客户端-服务器通信中起着至关重要的作用，因此在设计 API 时应始终牢记最佳实践。这有助于维护它们的开发人员以及使用它们的开发人员在执行这些职责时不会遇到问题。 在本文中，我将带您了解在制作 RE
blog-api::memo:博客REST API
03-18
博客REST API是基于Java开发的一款用于管理博客内容的Web服务接口。REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，它基于HTTP协议，通过URL定位资源，使用HTTP方法（GET、POST、...
nodejs-restapi-example::hot_springs:开源NodeJs RestAPI
05-19
本示例项目 "nodejs-restapi-example" 是一个开源的 Node.js 应用，旨在展示如何使用 Node.js 和相关库构建 RESTful API。 **1. 基础知识** - **Node.js**: Node.js 使用事件驱动、非阻塞 I/O 模型，使其轻量又...
使用Rest API设计简单的博客网站
sodifferent的博客
11-23 192
博客根地址 https://mygithub.com 对于每个用户自己的博客网站都在这个根地址后加url信息。 使用Rest API进行设计 在这里设计如下API： https://mygithub.com/...(username)/articles https://mygithub.com/...(username)/profile 对于get请求时返回的错误码设计如下： 100 //返...
博客网站API的设计
kjhmh2的博客
11-23 250
博客网站API的设计作业要求REST APIAPI设计用户登录查看某用户发布的所有文章列表查看某用户的所有粉丝查找某文章发布文章删除某篇文章查看某篇文章的评论给某篇文章添加评论给某篇文章点赞 作业要求 仿造github设计一个博客网站的REST API REST API REST是Representational State Transfer，即表现层状态转移的缩写，指的是查看，创建，编辑，删除这...
设计一个博客网站的API
weixin_40334756的博客
11-20 208
设计一个博客网站的API 设计格式： ·协议为: HTTPS ·博客根地址为：https://myblog.com ·所有数据以JSON形式发送和接收 认证方式： 基本认证 curl -u username https://myblog.com 通过输入用户名，然后再进行输入密码进行认证。需要身份验证的请求在某些地方将返回404 Not Found，而不是 403 Forbidden。这是为了防止...
设计博客网站的API
HuiFeiDeTuoNiaoGZ的博客
11-20 254
什么是API API是Application Programming Interface（应用程序接口）的缩写，它是拿来描述一个类库的特征或是如何去运用它。如今很多人常常参考一种通过网络分享应用数据的HTTP API。 当人们开始去实现自己的API接口时，问题就出现了：没有一个标准的方法来命名URL，人们总是要参考API才得知它是如何运作的。 什么是REST REST是Representation...
API设计
AJANEEE的博客
11-17 602
文章目录设计原则基本原则围绕资源组织 API：根据 HTTP 方法定义操作数据筛选和分页使用 HATEOAS 导航到相关资源一个博客网站的APICurrent versionSchema博客摘要博客详细内容认证方式基本认证登录失败参数root客户端错误HTTP verbs分页链接标题限速条件请求 设计原则 基本原则 使用 HTTP 设计 RESTful API 时的一些主要原则： REST A...
【转】基于XML-RPC的BloggerAPI学习
weixin_33842304的博客
02-03 168
　 Luliang的mail2blog脚本，通过基于XML-RPC的BloggerAPI来实现的发布blog的功能。　　BloggerAPI是一套程序接口，用以支持远程操作blog.这个规范现在的版本是1.0，是个试验版本和α版本。但是，规范的研发人员不再对BloggerAPI进一步地开发，他们正在制定一套新的、更稳定的API，新项目的名称为echo. 　　虽然如此，了解一下这个bloggerA...
设计一个博客网站的 API
mmdxm的博客
11-22 477
设计一个博客网站的 API 1.REST介绍 REST 定义了一组体系架构原则，您可以根据这些原则设计以系统资源为中心的 Web 服务，包括使用不同语言编写的客户端如何通过 HTTP 处理和传输资源状态。 如何考虑使用它的 Web 服务的数量，REST 近年来已经成为最主要的 Web 服务设计模式。 事实上，REST 对 Web 的影响非常大，由于其使用相当方便，已经普遍地取代了基于 SOAP 和...
REST风格的博客 API设计
xiekch的博客
11-21 225
本博客介绍REST风格的博客API设计。
设计一套良好 REST API
java、c++、机器学习方向King
03-12 7749
硅谷的apigee公司给出一份对REST API的设计指导原则，可以说这家公司在api开发，管理的成绩有目共睹。其提供的指导原则，可以说结合了其自身实际开发经验，诸多大型平台的实际运营经验和标准http规范。非常值得一读。首先，你需要对REST API有一个基本的概念认知，然后再深入阅读：1. 基于业务领域的数据建模，而非基于功能建模。例如，取得所有的dogGET /api/dogs 取得一个特...
使用REST API进行数据下载指南
RESTful API设计简洁且易于理解，是现代Web服务和移动应用开发中的主流选择。 在描述中提到的"Rest apiRest apiRest api..."可能是由于重复输入，实际应该是强调REST API的重要性或者表示需要进一步的信息。标签...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值