HW10_hw10是什么-CSDN博客

本文链接：https://blog.csdn.net/yqc1234/article/details/103223388

HW10

什么是REST API
作业要求
API设计

什么是REST API

REST API(Representational State Transfer) 是一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。
REST是面向资源的，强调描述应用程序的事物和名词。简洁的说，就是REST将资源的状态以最适合客户端或服务端的形式从服务器端转移到客户端。（或反过来）

作业要求

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

API设计

假设博客网站地址为 https://api.test.com

REST API常用HTTP请求方式

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

状态码

HTTP状态码（HTTP Status Code）是用以表示网页服务器超文本传输协议响应状态的3位数字代码。
常用的状态码如下：

100：继续客户端应当继续发送请求。客户端应当继续发送请求的剩余部分，或者如果请求已经完成，忽略这个响应。
101：转换协议在发送完这个响应最后的空行后，服务器将会切换到在Upgrade 消息头中定义的那些协议。只有在切换新的协议更有好处的时候才应该采取类似措施。
102：继续处理由WebDAV（RFC 2518）扩展的状态码，代表处理将被继续执行。
200：请求成功处理方式：获得响应的内容，进行处理
201：请求完成，结果是创建了新资源。新创建资源的URI可在响应的实体中得到处理方式：爬虫中不会遇到
202：请求被接受，但处理尚未完成处理方式：阻塞等待
204：服务器端已经实现了请求，但是没有返回新的信息。如果客户是用户代理，则无须为此更新自身的文档视图。处理方式：丢弃
300：该状态码不被HTTP/1.0的应用程序直接使用，只是作为3XX类型回应的默认解释。存在多个可用的被请求资源。处理方式：若程序中能够处理，则进行进一步处理，如果程序中不能处理，则丢弃
301：请求到的资源都会分配一个永久的URL，这样就可以在将来通过该URL来访问此资源处理方式：重定向到分配的URL
302：请求到的资源在一个不同的URL处临时保存处理方式：重定向到临时的URL
304：请求的资源未更新处理方式：丢弃
400：非法请求处理方式：丢弃
401：未授权处理方式：丢弃
403：禁止处理方式：丢弃
404：没有找到处理方式：丢弃
500：服务器内部错误服务器遇到了一个未曾预料的状况，导致了它无法完成对请求的处理。一般来说，这个问题都会在服务器端的源代码出现错误时出现。
501：服务器无法识别服务器不支持当前请求所需要的某个功能。当服务器无法识别请求的方法，并且无法支持其对任何资源的请求。
502：错误网关作为网关或者代理工作的服务器尝试执行请求时，从上游服务器接收到无效的响应。
503：服务出错由于临时的服务器维护或者过载，服务器当前无法处理请求。这个状况是临时的，并且将在一段时间以后恢复。

查看个人信息

GET /username

{
  "user_name":"testuser",
  "age":"20",
  "blogs_num":"13",
  "fans":"73",
  "follow":"21"
}

查看所有博客

GET /username/blogs

  "user_name":"testuser"
  "blogs_num":"13"
  "blogs":[
    {
      "articleID": 7,
      "blog_title": "title",
      "blog_url": "url"
      "private": false,
      "description": "...",
      "visits":123,
      "words": 2354,
      "content":"....",
      "created_at": "1111-11-11T11:11:11Z",
      "updated_at": "1112-11-11T11:11:11Z"
    },
    ...
  ]

发布博客

POST /username/blog/1341

data
{
	"content":"...",
	"title":"...",
	"private": true,
	"description":"..."
}
curl -u -i -d '{"title":"...","content":"...","private":true,"description":"..."}' https://api.test.com/username/blog/1341

{
 "is_published":true ,
 "blog":{
      "articleID": 7,
      "blog_title": "title",
      "blog_url": "url"
      "private": false,
      "description": "...",
      "visits":123,
      "words": 2354,
      "content":"....",
      "created_at": "1111-11-11T11:11:11Z",
      "updated_at": "1112-11-11T11:11:11Z"
    }
}

删除博客

DELETE /username/blogs/{id}

{
	"is_deleted":true,
	"id" : 13
}

curl -u -i -d https://api.test.com/username/blog/1341

修改博客

PUT /username/blogs/{id}

data
{
    "content":"...",
	"title":"..."
}
    
curl -u -i -d {"title":"...","content":"..."} https://api.test.com/username/blog/1341