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

最新推荐文章于 2023-09-05 13:14:57 发布

原创最新推荐文章于 2023-09-05 13:14:57 发布 · 347 阅读

0 ·

CC 4.0 BY-SA版权

IT 专栏收录该内容

4 篇文章

订阅专栏

网站的API：

https://api.exampleBlog.com

404 not fonud: 是HTTP对网页错误情况返回的一种状态码，
当用户在浏览器中输入网址时，服务器会根据输入的地址
判断是否有对应的网页信息，如果没有对应信息，
说明用户输入的可能是一串无效的链接，服务器就会向用户
返回404 not found状态码，告诉用户没有找到对应的网页信息。

403 not found: 403错误是一种在网站访问过程中，常见的错误提示，
表示资源不可用。服务器理解客户的请求，但拒绝处理它，
通常由于服务器上文件或目录的权限设置导致的WEB访问错误。

在主页上对网页的内容进行操作的时候主要会用到一下几个变量：

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。

主页：

登录之后就可以在下面的网址中看到用户的个人主页，里面有他的所有博客的基本信息和摘要

GET https://api.exampleBlog.com/username

或者查看该用户的最新文章：

GET https://api.exampleBlog.com/username/latest

如果想要查看某一篇博客的具体内容，则需要

GET https://api.exampleBlog.com/username/article_1

根据分类功能还可以获取到各种文章的类别

GET https://api.exampleBlog.com/username/classify

这些获取到的信息都会以JSON格式存储

然后是发布一篇文章，需要提供文章的一些具体信息

POST https://api.exampleBlog.com/username/article_2

删除某一篇文章：

DELETE https://api.exampleBlog.com/username/article_3

不管是查找还是发布还是删除的操作，都是需要利用curl来进行访问的

curl -i -u username -data '{"JSON FORM":["data"]}' https://api.exampleBlog.com/username

我使用cmd尝试输入curl -i www.baidu.com之后会有以下的输出

HTTP/1.1 200 OK
Accept-Ranges: bytes
Cache-Control: private, no-cache, no-store, proxy-revalidate, no-transform
Connection: Keep-Alive
Content-Length: 2381
Content-Type: text/html
Date: Thu, 21 Nov 2019 08:46:25 GMT
Etag: "588604ec-94d"
Last-Modified: Mon, 23 Jan 2017 13:28:12 GMT
Pragma: no-cache
Server: bfe/1.0.8.18
Set-Cookie: BDORZ=27315; max-age=86400; domain=.baidu.com; path=/

所以类似的，如果获取网站里的某一篇博客的话，就会返回某一篇博客以JSON为格式的信息，大致如下：

curl -i -u https://api.exampleBlog.com/username/article_1
HTTP/1.1 200 OK
...
{
	"author":username,
	"date":xxxx/xx/xx
	"title":article_1,
	"Abstract":xxx,
	"text":xxx,
}
...