模仿Github API编写设计一个博客网站的部分REST API

最新推荐文章于 2022-12-16 14:31:23 发布
最新推荐文章于 2022-12-16 14:31:23 发布
阅读量287 收藏
点赞数
分类专栏： 服务计算
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/kw411718198/article/details/103195590
版权

总览

当前版本

默认情况下，所有的https://api.Blog.com接受v1版本的REST API请求。

Accept:application/vnd.Blog.v1+json

架构图

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

curl -i https://api.Blog.com/users/octocat/orgs
HTTP/1.1 200 OK
Server: nginx
Date: Fri, 12 Oct 2012 23:33:14 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Status: 200 OK
ETag: "a00049ba79152d03380c34652f2cb612"
X-Blog-Media-Type: Blog.v1
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 /user1/blog

详细表示

当您想要获取单个博客时，响应通常包括该博客的所有属性
例如：当您想得到单个博客时，将获得该博客的详细表示：
GET /user1/list1/article1
该文档提供了每种API方法的示例响应。示例响应说明了该方法的所有属性。

HTTP动词

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

动词描述返回状态码
GET用于检索资源200-表示已在响应中发出 404-资源不存在 204-资源有空表示 406-服务端不支持所需表示 503-服务端当前无法处理请求
POST创建资源/更新部分资源200-如果现有资源已被更改 201-如果新资源被创建 204-资源有空表示 412- 前置条件失败（如执行条件更新时的冲突）415- 接受到的表示不受支持
PATCH部分更新资源400-指代坏请求 409-通用冲突 415- 接受到的表示不受支持
PUT创建或替换资源200-如果已存在资源被更改 201-如果新资源被创建 204-资源有空表示 412- 前置条件失败（如执行条件更新时的冲突）415- 接受到的表示不受支持
DELETE删除资源200-资源已被删除 303- 其他，如负载均衡 404-资源不存在 503-服务端当前无法处理请求

用户认证

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

基本认证
curl -u username https://api.Blog.com

在后续弹出的框中输入密码，或者

curl -u username:password https://api.Blog.com
登录限制失败

当使用无效的用户名和密码进行身份验证登录将返回401 Unauthorized:

curl -u errorname:errorpassword https://api/Blog.com
HTTP/1.1 401 Unauthorized
{
	"message":"Bad credentials",
	"documentation_url":"https://developer.Blog.com/v1"
}

属性操作

查看用户信息
  • 该API用来获取用户的所有主要信息
  • GET /username
  • 响应：
curl -u  kw411718198:123456 https://api/Blog.com/kw411718198

{
	Status：200 OK
	----------------
	"username":kw411718198,
	"age":3,
	"follower":csdn,
	"fans":null,
	"coin":0,
	"interestring field":AI,Computing Service,
	"created_at":2016-01-01T14:20:35+08:00
}
查看用户所有的博客
  • 该API用来查看用户的所有博客
  • GET /username/blog
  • 响应：
curl -u  kw411718198:123456 https://api/Blog.com/kw411718198/blog

{
	Status：200 OK
	----------------
	"total number":15
	"list":[
		"article1":{
			"title":"welcome to  csdn!",
			"words":255,
			"summary":"the article is a example for newcomers.",
			"Original"：true,
			"created_at": 2016-01-01T14:20:35+08:00,
			"modified_at": 2016-01-01T14:20:40+08:00,
			"read times":138,
			"comments":0
		},
		"article2":{
		....	
		}
	]
}
查看用户在某一分类下的博客
  • 该API用来查看用户的博客分类
  • GET /username/blog/list1
  • 响应：
curl -u  kw411718198:123456 https://api/Blog.com/kw411718198/blog/Computing Service

{
	Status：200 OK
	----------------
	"list name":"Computing Service",
	"total number":3,
	"list":[
		"article1":{
			"title":"CLI 命令行实用程序开发实战 - Agenda",
			"words":1025,
			"summary":"the article is mainly about a programmar development based on CLI.",
			"original"：true,
			"created_at": 2019-10-24T21:33:05+08:00,
			"modified_at": 2019-10-25T21:33:05+08:00,
			"read times":52,
			"comments":0
		},
		"article2":{
		....	
		}
	]
}
查看博客
  • 该API用来查看用户的博客
  • GET /username/blog/article
  • 响应：
curl -u  kw411718198:123456 https://api/Blog.com/kw411718198/blog/CLI 命令行实用程序开发实战 - Agenda

{
	Status：200 OK
	----------------
	"title":"CLI 命令行实用程序开发实战 - Agenda",
	"created_at":2019-10-24T21:33:05+08:00,
	"modified_at": 2019-10-25T21:33:05+08:00,
	"read times":53,
	"listed":"Computing Service",
	"original"：true,
	"link":https://api/Blog.com/kw411718198/blog/CLI 命令行实用程序开发实战 - Agenda,
	"content":"agende项目是一个CLI程序，可以进行用户管理，会议管理等遍历操作。按照本次作业的要求，实现其中的两条指令——register和log in...."
}
查看博客摘要
  • 该API用来查看用户编辑的博客摘要
  • GET /username/blog/article/summary
  • 响应：
curl -u -d kw411718198:123456 https://api/Blog.com/kw411718198/blog/CLI 命令行实用程序开发实战 - Agenda/summary

{
	Status：200 OK
	----------------
	"title":"CLI 命令行实用程序开发实战 - Agenda",
	"created_at":2019-10-24T21:33:05+08:00,
	"modified_at": 2019-10-25T21:33:05+08:00,
	"read times":53,
	"listed":"Computing Service",
	"original"：true,
	"link":https://api/Blog.com/kw411718198/blog/CLI 命令行实用程序开发实战 - Agenda,
	"summary":"agende项目是一个CLI程序，可以进行用户管理，会议管理等遍历操作。按照本次作业的要求，实现其中的两条指令——register和log in。"
}
发布博客
  • 该API供用户进行博客发布
  • POST /username/blog/article
  • 响应：
curl -u -p kw411718198:123456 {"title":"IT与风险投资","listed":"Computing Service","original":true,"summary":"some thoughts about a book."}https://api/Blog.com/kw411718198/blog

{
	Status：200 OK
	----------------
	"title":"CLI 命令行实用程序开发实战 - Agenda",
	"created_at":2019-10-24T21:33:05+08:00,
	"modified_at": 2019-10-25T21:33:05+08:00,
	"read times":53,
	"listed":"Computing Service",
	"original"：true,
	"link":https://api/Blog.com/kw411718198/blog/CLI 命令行实用程序开发实战 - Agenda,
	"summary":"agende项目是一个CLI程序，可以进行用户管理，会议管理等遍历操作。按照本次作业的要求，实现其中的两条指令——register和log in。"
}
修改博客
  • 该API供用户进行博客修改
  • `PATCH /username/blog/article
  • 响应：
curl -u -pt kw411718198:123456 {"content_from":"*****","content_to":"+++++"}https://api/Blog.com/kw411718198/blog/IT与风险投资

{
	Status：200 OK
	----------------
	"title":"IT与风险投资",
	"listed":"Computing Service",
	"created_at":2019-11-25T21:56:05+08:00,
	"modified_at": 2019-10-25T23:33:05+08:00,
	"original"：true,
	"link":https://api/Blog.com/kw411718198/blog/IT与风险投资,
	"content_from":"*****",
	"content_to":"+++++"
}
删除博客
  • 该API供用户进行博客删除
  • DELETE /username/blog/article
  • 响应：
curl -u -d kw411718198:123456 {"title":"IT与风险投资"}https://api/Blog.com/kw411718198/blog/IT与风险投资

{
	Status：200 OK
	----------------
	"title":"IT与风险投资",
	"created_at":2019-10-24T21:33:05+08:00,
	"deleted_at":2019-10-29T21:33:05+08:00
}
创建博客评论
  • 该API供用户进行博客评论的创建
  • POST /username/blog/article/comments/number
  • 响应：
curl -u -p sr2630459443:456123 {"comments":"*****"}https://api/Blog.com/kw411718198/blog/IT与风险投资/comments/1

{
	Status：201 OK
	----------------
	"title":"IT与风险投资",
	"listed":"Computing Service",
	"author":kw411718198,
	"commentator":sr2630459443,
	"id":1,
	"created_at":2019-11-29T21:33:05+08:00,
	"comments":"*****"
}
查看博客评论
  • 该API供用户查看当前博客的所有评论
  • GET /username/blog/article/comments
  • 响应：
curl -u  kw411718198:123456 https://api/Blog.com/kw411718198/blog/IT与风险投资/comments

{
	Status：200 OK
	----------------
	"total number":3,
	"list":[
		"comment1":{
			"words":1025,
			"id":1,
			"commentator":sr2630459443,
			"created_at":2019-11-29T21:33:05+08:00,
			"praise points":5,
			"comments":"*****",
			"reply":[
				....
			]
		},
		"comment2":{
		....	
		}
	]
}

时区

一些创建新博客的请求允许您在指定或生成时间戳时提供时区信息。我们按照优先级顺序应用以下规则，以确定API调用的时区信息。

  • 明确提供带有时区信息的ISO 8601时间戳
  • 使用用户的最后一个已知时区
  • 默认为UTC，没有其他时区信息
明确提供带有时区信息的ISO 8601时间戳

对于允许指定时间戳的API调用，我们使用该确切的时间戳。
这些时间戳看起来像2019-11-22T11:22:06+08:00。

使用用户的最后一个已知时区

如果未明确提供时间戳，并且您对API进行了身份验证的调用，那么我们将使用身份验证用户的最后一个已知时区，当您编辑Blog网站时，最新的时区将会更新。

默认为UTC，没有其他时区信息

如果以上步骤未产生任何信息，我们将UTC用作时区来进行博客更改后的提交时间。

后续想法

在访问的路径结构中，博客主要分布在username/blog目录下，在username的的目录下还将设置例如organization(供用户组成讨论组织)、forum（供用户进行论坛交流）、developer（供用户进行自主的网站开发）等项目。

kw411718198
关注
专栏目录
基于markdown的博客网站Rest API设计
agent0024的博客
11-19 402
本次作业基于markdown编写了一个模仿github api的rest api 数据架构 由于Http是唯一与REST相关的实例，本文的实现通过HTTP实现REST，所有的API访问基于HTTPS进行 访问博客网站的API，https://api.BlogExample.com来进行数据的访问，所有数据通过JSON形式进行发送和接收 资源是Restful API的核心元素，所有的操作...
博客网站的API设计
lc429716918的博客
11-22 474
设计博客网站的的部分REST API 本篇博客的主要目的是模仿github API，编写设计一个博客网站的部分REST API。 在字博客中使用的博客网站域名为 https://api.MyExampleBlog.com 1.REST REST是Representational State Transfer（表现层状态转移）的缩写，它是由罗伊·菲尔丁（Roy Fielding）提出的，是用来描...
blog:基于Github API 的动态博客
04-28
欢迎来到我的个人主页 本站托管于 Github，所有数据来源于 Github，通过动态加载数据渲染页面 将Server Less进行到底 特性 博客 代码片段 Gist 仓库集合 计划任务 TODO 响应式 Progressive Web Apps 数据持久化 按需加载 静态类型检查 i18n 分析 Github 相关数据 集成 支持 技术栈 React 全家桶 Ant-Design Github Api Flow 为什么不使用 Hexo 之类的静态站点 Hexo 的流程: 新建一个 xxx.md(无论是手动或命令行) 编辑相应的信息, 如发布日期, 分类, 标签, 内容. 本地预览 将 markdown 构建成 html 静态文件 部署到服务器 push 源代码 它并不适合我: 疲与上面的步骤 依赖于开发环境，首先你要有 NodeJS 以及 Hexo 修改麻烦，
经典的API设置
ronon77的专栏
02-09 1202
        1. 使用 HTTPS 这个和 Restful API 本身没有很大的关系，但是对于增加网站的安全是非常重要的。特别如果你提供的是公开 API，用户的信息泄露或者被攻击会严重影响网站的信誉。 NOTE：不要让非SSL的url访问重定向到SSL的url。 2. API 地址和版本 在 url 中指定 API 的版本是个很好地做法。如果 API 变化比较大，可以把 API ...
github api设计赏析
weixin_33754065的博客
09-13 151
本文将以赏析github的api为主题，深入探索restful api的优雅实现
使用GitHub API 写博客
weixin_33910759的博客
05-20 427
演示地址 https://saltfish666.github.io 仓库地址 思路 用GitPage托管静态资源，repo的issues来存储博客内容和评论,并通过GitHubAPI来访问 整个项目有三个界面，首页，文章页面，写/编辑文章页面 创建一个repo，这个repo的issues用来存储博客内容 需要额外的服务器吗 因为GitHubAPI限制，只有登录后的用户才能正常使用，这一步必须得有...
跟着 Github 学习 Restful HTTP API 设计
u012996572的博客
03-17 874
近几年提供 HTTP API 服务的公司越来越多，许多公司都把 API 作为产品重要的一部分，作为服务提供出去。而微服务的兴起，也让企业内部开始重视和频繁使用 HTTP API 。好的 HTTP API 设计容易理解、符合 RFC 标准、提供使用者便利的功能，其中经常被拿来作为教科书典范的当属 Github API。本篇文章通过 Github API 总结了一些非常好的设计原则，可以作为以后要编写...
Kotlin+Spring Boot开发REST API实战
板三的梦
07-23 3418
Kotlin与JAVA对比简洁之处、不同之处；从基础配置、Entity、Repository、REST Controller，到异常处理、Security、测试、集成Swagger，一步步学习Kotlin+Spring Boot开发。
马斯克都不懂的 GraphQL，API 网关又能对其如何理解？
最新发布
ApacheAPISIX的博客
12-16 535
作者，罗泽轩 上个月马斯克评论Twitter App 滥用 RPC 后，与一些 Twitter 的技术主管发生了矛盾 —— 直言马斯克不懂技术。那这个马斯克都不懂的 GraphQL 到底是什么？ 什么是 GraphQL？它有多流行？ GraphQL 是一套由 Facebook 在 2015 年发布的一套面向 API 的查询操作语言。相比于其他的 API 设计方式，GraphQL 允许客户端根据事先约定的数据结构组建查询语句，由服务端解析这一语句并只返回所需的内容。这么一来，GraphQL 在提供丰富
GitHubTimeline只要输入用户名就能看到该用户自己看到的GitHub时间线
08-10
GitHub Timeline 是一个基于JavaScript和CSS技术构建的工具，它允许用户通过输入GitHub用户名来查看该用户的个人时间线，展示他们在GitHub上的活动记录。这个工具可能是为了帮助开发者更好地了解其他开发者的工作...
服务计算——模仿GithubAPI编写设计一个博客网站的部分RESTAPI
weixin_37863947的博客
11-19 583
Web API 参考博客链接 Overwview WebAPI - API的概念 - Web API的概念 DOM - DOM的概念 - DOM经常进行的操作 获取页面元素 - 为什么要获取页面元素 事件 - 事件三要素 - 事件的基本使用 属性 - 非表单元素的属性 - 表单元素属性 - 案例 - 自定义属性操作 - 样式操作 - 类名操作 - 案例 创建元素的三种方式 -...
Service-computing-hw10：模仿Github API编写设计一个博客网站的部分REST API
Zero
11-18 384
文章目录一些基本规则PART1 协议PART2 域名PART3 版本PART4 路径PART5 HTTP动词PART6 过滤信息PART7 状态码PART8 数据格式API列表登录账号查看发表的所有文章取得特定的文章搜素文章查看文章评论创建评论发布文章删除文章修改文章查看关注者查看被关注者 一些基本规则 PART1 协议 API与用户的通信协议，总是使用HTTPs协议。 PART2 域名 http...
html 接口文档生成,记一次使用Spring REST Docs + travis + github自动生成API接口文档的操作步骤（上）...
weixin_32260467的博客
06-04 342
团队开发中，文档尤为重要。文档的存大，大幅的降低了团队间的无效沟通时间，使得每位成员即可以按自己的计划开始工作，又可以快速的获取到其它队员的支持。优秀的程序员从善于读文档开始，优秀的工程师从善于写文档开始。在前后台的开发中，接口是使前后台进行关联的关键一环，接口是否合理，清晰直接影响到团队开发的效率和团队间配置的心情(程序员往往都是自恋的坏脾气)。而是否能够提供随时更新的阅读性强的文档，则是前后台...
GitHub Api用户和仓库常用接口
weixin_43829154的博客
10-11 1万+
准备工作 官方文档：https://docs.github.com/en/rest/reference 1、申请github api token 2、在请求header中添加Authorization和Accept，例如： 用户 用户集合 请求说明 显示所有github用户信息，默认按id递增。 Name Type In Description accept string header Setting to application/vnd.github.v3+json is recomme
Python
qq_36864672的博客
09-23 1万+
Python进阶(一)-初识Python数据元素:列表&元组   毕业论文已完成，下面就是等待盲审结果了。在此期间，已感觉论文无从看起。就学习一下Python吧，听说这是一门很神奇的语言。下面言归正传~    在线文档查询：点击查看    IDE：IntelJ。    有关IntelJ的安装与注册详见博文《IntelliJ IDEA 2016注册方法和注册码》。    下面介绍一下P
推荐 GitHub 上的一套公开 API 接口，简直不要太全！
AI研习社
12-03 2349
开发者（KaiFaX）面向全栈工程师的开发者专注于前端、Java/Python/Go/PHP的技术社区对于程序员来说，为自己的程序选择一些合适的API并不是那么简单，有时候还会把你搞得够呛，今天要和大家分享一个开源项目，这个项目汇集了各种开发的api，涵盖了音乐、新闻、书籍、日历等，无论你是从事Web开发还是Android或者是iOS开发，这里面准有你需要的这个项目就叫——public-apis，...
【面经专栏】独家整理【C++】面经
日月既往，不可复追
10-18 2196
C++ 1、动态库的查找顺序 ELF文件的DT_RPATH段 环境变量LD_LIBRARY_PATH 库高速缓存/etc/ld.so.cache文件列表 默认路径/lib /usr/lib 2、虚继承，多重继承中派生类对象内有谁 3、RTTI，typeid是怎么知道指向对象的类型的 ​ typeid函数的主要作用就是让用户知道当前的变量是什么类型的，比如使用typeid(a).name()就能知道变量a是什么类型的。typeid()函数的返回 类型为type_info类型的引用 ​ 运行时的多态是通
如何优雅的“编写”api接口文档
热门推荐
纸上得来终觉浅,绝知此事要躬行
05-04 2万+
使用Swagger来规范并自动化你的API文档
gitbook--好用的编写API文档工具
lintcgirl的博客
01-10 1万+
参考资料：http://gitbook.zhangjikai.com/index.html创建一个gitbook仓库包含基本的文件：.gitignore SUMMARY.md（撰写左边导航栏） README.md（简介） book.json（对gitbook基本的配置，有的时候你一个这样的仓库，可能没有该文件，可自行创建）遇到的坑：请使用gitbook2.6.7版本，使用最新版本3点几的话，出
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值