服务计算 | 博客网站的部分REST API设计

最新推荐文章于 2021-04-15 13:40:41 发布
最新推荐文章于 2021-04-15 13:40:41 发布
阅读量290 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Vickyiiiiii/article/details/103169804
版权

文章目录

当前版本

默认情况下，所有http://api.myblog.com接收v3 版本的REST API的请求

Accept: application/vnd.myblog.v3+json

架构图

所有API访问都是通过HTTPS进行的，并且可以通过访问https://api.myblog.com。所有数据都以JSON的形式发送和接收。

curl -i https://api.myblog.com/users/octocat/orgs
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 19 Nov 2019 23:33:14 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Status: 200 OK
ETag: "a00049ba79152d03380c34652f2cb612"
X-GitHub-Media-Type: github.v3
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4987
X-RateLimit-Reset: 1350085394
Content-Length: 5
Cache-Control: max-age=0, private, must-revalidate
X-Content-Type-Options: nosniff

包含空白字段，null而不是将其省略。

所有时间戳以ISO 8601格式返回：

YYYY-MM-DDTHH:MM:SSZ

摘要表示

当您获取资源列表时，响应包括该资源的属性子集。这是资源的“摘要”表示。
查看发表的所有文章
GET /:username/articles

认证方式

有两种方法可以通过GitHub API v3进行身份验证。需要身份验证的请求在某些地方将返回404 Not Found，而不是403 Forbidden。这是为了防止私有存储库意外泄露给未经授权的用户。

基本认证

curl -u "username" https://api.myblog.com

OAuth2令牌（在标头中发送）

curl -H "Authorization: token OAUTH-TOKEN" https://api.myblog.com

OAuth2密钥/秘密

弃用通知： GitHub将使用查询参数终止对API的身份验证。对API的身份验证应使用HTTP基本身份验证完成。

curl 'https://api.myblog.com/users/whatever?client_id=xxxx&client_secret=yyyy'
使用您的client_id，client_secret并且不对用户进行身份验证，它只会识别您的OAuth应用程序以增加您的速率限制。权限仅授予用户，而不授予应用程序，并且您将仅取回未经身份验证的用户将看到的数据。因此，您仅应在服务器到服务器方案中使用OAuth2密钥/秘密。请勿将OAuth应用程序的客户端机密泄露给用户。

登录限制失败

使用无效的凭据进行身份验证将返回401Unauthorized：

curl -i https://api.myblog.com -u foo:bar
HTTP/1.1 401 Unauthorized
{
  "message": "Bad credentials",
  "documentation_url": "https://developer.myblog.com/v3"
}

在短时间内检测到多个具有无效凭据的请求后，API会临时拒绝该用户的所有身份验证尝试（包括具有有效凭据的请求）403 Forbidden：

curl -i https://api.github.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.github.com/v3"
}

参量

许多API方法采用可选参数。对于GET请求，任何未在路径中指定为段的参数都可以作为HTTP查询字符串参数传递：
curl -i“ https://api.myblog.com/repos/vmg/redcarpet/issues?state=closed”
在此示例中，在查询字符串中传递路径时，为路径中的:owner 和:repo参数提供了’vmg’和’redcarpet’值:state。
对POST，PATCH，PUT，和DELETE的要求，不包含在URL参数应当被编码为JSON与“应用/ JSON”的内容类型：
curl -i -u username -d '{"scopes":["public_repo"]}' https://api.myblog.com/authorizations

根端点

您可以用GET向根端点发出请求，以获取REST API v3支持的所有端点类别：
curl https://api.myblog.com

客户端错误

接收请求正文的API调用上可能存在三种类型的客户端错误：

  1. 发送无效的JSON将导致400 Bad Request响应。
HTTP/1.1 400 Bad Request
Content-Length: 35

{"message":"Problems parsing JSON"}
  1. 发送错误类型的JSON值将导致400 Bad Request响应。
HTTP/1.1 400 Bad Request
Content-Length: 40

{"message":"Body should be a JSON object"}
  1. 发送无效的字段将导致422 Unprocessable Entity 响应。
HTTP/1.1 422 Unprocessable Entity
Content-Length: 149

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    }
  ]
}

所有错误对象都具有资源和字段属性，以便您的客户端可以知道问题所在。还有一个错误代码，让您知道该字段出了什么问题。这些是可能的验证错误代码：

错误名称描述
missing意味着资源不存在
missing_field意味着尚未设置资源上的必填字段
invalid这意味着字段格式无效。该资源的文档应该能够为您提供更多具体信息
already_exists这意味着另一个资源具有与此字段相同的值。在必须具有某些唯一键（例如标签名称）的资源中可能会发生这种情况。

HTTP重定向

API v3在适当的地方使用HTTP重定向。客户应假定任何请求都可能导致重定向。接收HTTP重定向不是错误，客户端应遵循该重定向。重定向响应将具有一个 Location标头字段，其中包含客户端应向其重复请求的资源的URI。

状态码描述
301永久重定向。您用于发出请求的URI已被Location标头字段中指定的URI取代。对此资源的此请求以及所有将来的请求都应定向到新URI。
302, 307临时重定向。应按Location标头字段中指定的URI逐字重复请求，但客户端应继续将原始URI用于以后的请求。

HTTP动词

API v3尽可能在每个动作中使用适当的HTTP动词。

  • HEAD: 可以针对任何资源发出以仅获取HTTP标头信息。
  • GET: 用于检索资源。
  • POST: 用于创建资源。
  • PATCH: 用于通过部分JSON数据更新资源。例如，问题资源具有title和body属性。PATCH请求可以接受一个或多个属性以更新资源。PATCH是一个相对较新且不常见的HTTP动词，因此资源端点也接受POST请求。
  • PUT: 用于替换资源或集合。对于PUT没有body属性的请求，请确保将Content-Length标头设置为零。
  • DELETE: 用于删除资源。
基本操作

登录
curl -u username:password https://api.myblog.com/v1
假设用名为zyh的账户登录

  1. 查看发表的所有文章
GET /:username/articles
curl -i -u https://api.myblog.com/v1/zyh/articles
  1. 查看特定的文章
GET /:username/articles/{id}
GET /:username/articles/{title}

curl -u -i https://api.myblog.com/v1/zyh/articles/1
curl -u -i https://api.myblog.com/v1/zyh/articles/bjyxszd
  1. 搜索文章
POST /:username/articles/?{id}{name}{data}
curl -u -i https://api.myblog.com/v1/zyh/articles?id=1&title=xxx&data=xxx
  1. 查看评论
GET /:username/articles/:id/comments
curl -i https://api.myblog.com/v1/zyh/articles/20/comments
  1. 新建评论
POST /:user/:id/comment
data //评论参数
{
	"content":"xxx"
}

curl -u -i https://api.myblog.com/v1/zyh/articles/20/comments -d {"content":"xxx"}
  1. 发布文章
POST /:user/articles

data //发布文章的数据参数
{
	"content":"",
	"title":"",
	"private": true/false,
	"description":""
}
curl -u -i -d '{"title":"xxx","content":"xxx","private":false,"description":"xxx"}' https://api.myblog.com/v1/zyh/articles
  1. 删除文章
DELETE /:user/articles/{id}
  1. 修改文章
PUT /:user/articles/{id}

data 
{
    "content":"",
	"title":"",
}
    
curl -u -i -d {"title":"","content":"xxx"} https://api.myblog.com/v1/zyh/articles/20/

超媒体

所有资源都可以具有一个或多个*_url链接到其他资源的属性。这些旨在提供显式URL，以便适当的API客户端不需要自己构造URL。强烈建议API客户端使用这些。这样做将使开发人员将来更容易升级API。预期所有URL都是正确的RFC 6570 URI模板。

然后，您可以使用uri_template gem之类的东西来扩展这些模板：

>> tmpl = URITemplate.new('/notifications{?since,all,participating}')
>> tmpl.expand
=> "/notifications"

>> tmpl.expand :all => 1
=> "/notifications?all=1"

>> tmpl.expand :all => 1, :participating => 1
=> "/notifications?all=1&participating=1"

分页

默认情况下，返回多个项目的请求将被分页为30个项目。您可以使用?page参数指定其他页面。对于某些资源，您还可以使用?per_page参数设置最大100的自定义页面大小。请注意，出于技术原因，并非所有端点都遵守该?per_page参数，例如请参阅事件。
curl'https://api.myblog.com/user/repos?page=2&per_page=100'
请注意，页码是基于1的，省略该?page 参数将返回第一页。

连接标题

该链接头包括分页信息：
Link: <https://api.myblog.com/user/repos?page=3&per_page=100>; rel="next", <https://api.myblog.com/user/repos?page=50&per_page=100>; rel="last"
此Link响应标头包含一个或多个超媒体链接关系，其中一些可能需要扩展为URI模板。

可能的rel值为：

名称描述
next结果的下一页的链接关系
last最后一页结果的链接关系
first结果首页的链接关系
prev前一页结果的链接关系

限速

对于使用基本身份验证或OAuth的API请求，您每小时最多可以进行5000个请求。无论使用了基本身份验证还是OAuth令牌，经过身份验证的请求都与经过身份验证的用户相关联 。这意味着，当用户授权的所有OAuth应用程序使用同一用户拥有的不同令牌进行身份验证时，它们每小时共享5000个请求的相同配额。

对于未经身份验证的请求，速率限制允许每小时最多60个请求。未经身份验证的请求与原始IP地址相关联，而不与发出请求的用户相关联。

请注意，Search API具有自定义速率限制规则。

任何API请求返回的HTTP标头都会显示您当前的速率限制状态：

curl -i https://api.myblog.com/users/octocat
HTTP/1.1 200 OK
Date: Tue, 19 Nov 2019 17:27:06 GMT
Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 56
X-RateLimit-Reset: 1372700873

参数解释：

  • X-RateLimit-Limit：每小时允许您发出的最大请求数。
  • X-RateLimit-Remaining：当前速率限制窗口中剩余的请求数。
  • X-RateLimit-Reset：当前速率限制窗口重置的时间，以UTC纪元秒为单位。

如果超出速率限制，则会返回错误响应：

HTTP/1.1 403 Forbidden
Date: Tue, 19 Nov 2019 14:50:41 GMT
Status: 403 Forbidden
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1377013266
{
   "message": "API rate limit exceeded for xxx.xxx.xxx.xxx. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)",
   "documentation_url": "https://developer.github.com/v3/#rate-limiting"
}

用户代理

所有API请求都必须包含有效的User-Agent标头。没有User-Agent 标题的请求将被拒绝。我们要求您使用GitHub用户名或应用程序名称作为User-Agent标头值

User-Agent: Awesome-Octocat-App

User-Agent默认情况下，cURL发送一个有效的头。如果您User-Agent通过cURL（或通过替代客户端）提供了无效的标头，则会收到403 Forbidden响应：

curl -iH 'User-Agent: ' https://api.myblog.com/meta
HTTP/1.0 403 Forbidden
Connection: close
Content-Type: text/html
Request forbidden by administrative rules.
Please make sure your request has a User-Agent header.
Check https://developer.github.com for other possible causes.
Vickyiiiiii
关注
服务计算|模仿Github设计博客网站的API
qq_40328334的博客
11-26 134
一、REST简介 REST 是一种基于超媒体构建分布式系统的架构风格。 REST 独立于任何基础协议，并且不一定绑定到 HTTP。 但是，最常见的 REST 实现使用 HTTP 作为应用程序协议 。 HTTP 设计 RESTful API 时的一些主要原则： REST API 围绕资源设计，资源是可由客户端访问的任何类型的对象、数据或服务。 每个资源有一个标识符，即，唯一标识该资源的 URI...
使用Rest API设计简单的博客网站
sodifferent的博客
11-23 204
博客根地址 https://mygithub.com 对于每个用户自己的博客网站都在这个根地址后加url信息。 使用Rest API进行设计 在这里设计如下API： https://mygithub.com/...(username)/articles https://mygithub.com/...(username)/profile 对于get请求时返回的错误码设计如下： 100 //返...
Python:使用API——使用Web API
chy的博客
08-27 6118
来源：《Python编程：从入门到实践》 1 使用Web API Web API是网站的一部分，用于与使用非常具体的URL请求特定信息的程序交互——这种请求称为API调用 请求的数据将以易于处理的格式（JSON/CSV）返回 依赖于外部数据源的大多数应用程序都依赖于API调用 1.1 Git 和 GitHub 这里将使用GitHub的API来请求有关该网站中Python项目的信息，然后使...
Elasticsearch学习笔记
热门推荐
KISS
04-15 30万+
- - - - 第1章 Elasticsearch概述 - 01-开篇 02-技术选型 03-教学大纲 - 第2章 Elasticsearch入门 - 04-入门-环境准备 05-入门-RESTful & JSON 06-入门-Postman客户端工具 07-入门-倒排索引 08-入门-HTTP-索引-创建 09-入门-HTTP-索引-查询 & 删除 10-入门-HTTP-文档-创建（Put & Post） 11-入门-HTTP-查询-主键查询 &...
Validation failed判断错误
weixin_44538151的博客
06-17 1万+
Validation failed判断错误 开发工具与关键技术：Visual Studio 2015 作者：昨夜星辰 撰写时间：2019年 06月 18日 一、 在我开发项目的时候遇到了一个判断数据的错误跳转，就是一个提示判断数据的错误跳转，就如 下图的新增功能的样式，页面的判断数据没有显示，最新的查询表格的...
客户端验证：Validation
weixin_46584601的博客
11-12 260
Spring Boot在内部通过集成hibernate-validation已经实现了JSR-349验证规范接口，在Spring Boot项目中只要直接使用就行了。 一般用在Controller中用于验证前端传来的参数。 验证分两种：对封装的Bean进行验证 或者 对方法简单参数的验证。 文章目录validation与 springboot 结合1. bean 中添加标签2. Controller中开启验证3. resource 下新建错误信息配置文件4. 自定义异常处理器，捕获错误信息5. 附上部分标
模仿 Github 设计博客网站的 API
abc15837998448的博客
11-23 576
一、 作业要求 模仿 Github，设计一个博客网站的 API REST API 的设计原则 HTTP 协议定义了大量为请求赋于语义的方法。API访问都是通过HTTPS协议进行的，并通过https://api.blog.com进行访问，数据以JSON的形式发送和接收 使用 HTTP 设计 RESTful API 时的一些主要原则： REST API 围绕资源设计，资源是可由客户端访问的任何类型...
【服务计算】REST API设计
Excef的博客
11-21 210
文章目录 作业内容 REST REST API设计 架构概述 部分API设计 用户登录 新建博客 修改博客 删除博客 查看博客 查看评论 发表评论 作业内容 模仿github API，用markdown编写设计一个博客网站的部分REST API。 REST REST（Representational State Transfer，表现层状态装换）是Roy Thoma...
REST API 安全设计指南
The magic of fingertips
06-30 2082
REST API 安全设计指南。REST的全称是REpresentational State Transfer，它利用传统Web特点，提出提出一个既适于客户端应用又适于服务端的应用的、统一架构，极大程度上统一及简化了网站架构设计。 目前在三种主流的Web服务实现方案中，REST模式服务相比复杂的SOAP和XML-RPC对比来讲，更加简洁，越来越多的web服务开始使用REST设计并实现。但其缺少安全特性，《REST API 安全设计指南》就是一个REST API安全设计的指南，权当抛砖引玉，推荐网站后台设计及
PHP-Blog:带有Rest API的简单博客应用
03-09
路由是REST API设计的关键部分，它负责将HTTP请求映射到相应的处理函数。在PHP中，可以使用框架（如Laravel或Slim）或者自定义的路由系统来实现。路由规则通常基于URL模式和HTTP方法，例如`/api/posts`对应文章列表...
Android WordPress应用博客平台-IT计算机-毕业设计.zip
04-01
6. **WordPress REST API**：这个应用很可能是利用WordPress的REST API来获取和更新博客内容。了解如何构造API请求，处理响应，并将数据映射到本地模型是开发的关键部分。 7. **异步处理和线程管理**：由于网络操作...
httpie与REST API设计：构建用户友好的API接口
[httpie与REST API设计：构建用户友好的API接口](https://softuni.org/wp-content/uploads/2022/07/HTTP-Request-Methods-e1657276635747.png) # 1. HTTP与REST API的基本概念 ## HTTP简介与功能 超文本传输协议...
Django REST API设计：基于generics创建RESTful接口的快速指南
![Django REST API设计：基于generics创建RESTful接口的快速... Django REST API设计概述 ## 简介 REST（Representational State Transfer）架构风格是一种用于分布式超媒体系统的软件架构风格，由Roy Fielding在其博
Shopify developers（RESTAPI接口整理）
weixin_44281696的博客
04-30 6715
Shopify developers 作用： 解决了许多最困难的商业问题，但每个企业都有其独特的需求。 REST reference（REST参数） Shopify Payments Balance（余额）： 帐户的当期余额。这个数额包括任何交易尚未包括在支出. 检查账户的余额 Dispute（纠纷）： 当买方对其金融机构的一项指控的合法性提出质疑 争议财产属性（id,or...
广东工业大学22级物联网工程概率论复习资料
11-13
广东工业大学22级物联网工程概率论复习资料，包括PPT、习题（含答案）、期末考试题册（含答案）。 这门概率论课程主要讲解了概率的基本概念、随机变量、概率分布及其应用。课程内容包括离散和连续随机变量的分布、数学期望与方差、极限定理、大数法则、以及多维随机变量的联合分布等。通过学习，学生将掌握概率模型的建立和应用，能够运用概率论方法解决实际问题，分析和预测复杂系统的行为。此外，课程还涉及了一些经典的概率问题与应用，如随机过程、贝叶斯理论等，为后续的统计学、数据分析以及各类工程学科的深入研究提供了坚实的理论基础。
Image_226679847094279.jpg
11-13
Image_226679847094279.jpg
java项目，课程设计-ssm留学生交流互动论坛网站.zip
11-13
本文以Java为开发技术，实现了一个留学生交流互动论坛网站。留学生交流互动论坛网站的主要实现功能包括：管理员：首页、个人中心、学生管理、经验分享管理、计划分享管理、软件推荐管理、网址推荐管理、标签分类管理、留言板管理、交流论坛、系统管理，学生；首页、个人中心、经验分享管理、计划分享管理、软件推荐管理、网址推荐管理、标签分类管理，前台首页；首页、经验分享、计划分享、软件推荐、网址推荐、交流论坛、学习资讯、留言反馈、个人中心、后台管理功能，基本上实现了整个留学生交流互动论坛网站的过程。 具体在系统设计上，采用了B/S的结构，同时，也使用Java技术在动态页面上进行了设计，后台上采用Mysql数据库，是一个非常优秀的留学生交流互动论坛网站。
java超市销售管理系统源码 超市综合管理系统源码数据库 MySQL源码类型 WebForm
最新发布
11-13
JAVA超市销售管理系统源码 超市综合管理系统源码 1、安装myeclipse 10，并且配置 tomcat6 2、导入项目工程 3、导入Mysql数据库，首先新建mysql数据库，数据库的名字为 脚本名称 4、修改数据库连接字符串，修改连接密码 5、发布工程到tomcat中
【小程序毕业设计】基于微信小程序的夏津县汽车站购票系统设计与实现源码（完整前后端+mysql+说明文档）.zip
11-13
环境说明： 开发语言：Java/php JDK版本：JDK1.8 数据库：mysql 5.7及以上 数据库工具：Navicat11及以上 开发软件：eclipse/idea 小程序框架：uniapp/原生小程序 开发工具：HBuilder X/微信开发者
REST API设计指南：核心原则与实践
"REST API Design Rulebook by Mark Massé提供了RESTful API设计的全面指南，涵盖了标识、交互、元数据和表现等方面的最佳实践。" 在软件开发领域，REST（Representational State Transfer）已经成为构建Web服务的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值