认识一下什么是RestfulAPI

最新推荐文章于 2025-04-30 16:35:39 发布

longlong6682

最新推荐文章于 2025-04-30 16:35:39 发布

阅读量3.7k

点赞数 2

CC 4.0 BY-SA版权

分类专栏：网络文章标签： restfulapi

本文链接：https://blog.csdn.net/longlong6682/article/details/106045889

网络专栏收录该内容

8 篇文章

订阅专栏

本文介绍了RESTful API的概念，它是面向资源的编程方法，通过HTTP的GET、POST、PUT、DELETE等方法进行增删改查操作。文章详细解析了HTTP请求的组成部分，包括谓词、URL和HTTP协议版本，并探讨了RESTful API中的HEAD信息，如User-Agent、Authorization、Accept和Content-Type等。此外，还提供了创建Django项目并实现RESTful API的实例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一. RestfulAPI与HTTP简介

1、什么是RestfulAPI

REST直接翻译：表现层状态转移，实质就是一种面向资源编程的方法
REST描述的是在网络中client和server的一种交互形式；REST本身不实用，实用的是如何设计 RESTful API（REST风格的网络接口）
RestfulAPI中认为网络上所有的东西都是一种资源，对这些资源操作时无非就是增删改查
网络上的资源一般都用一段url代替,比如：http://www.chnsys.com/asset 代替资产资源
根据发送请求的method方法判断如何操作这些资源
- GET（SELECT）：从服务器取出资源（一项或多项）。
- POST（CREATE）：在服务器新建一个资源。
- PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
- DELETE（DELETE）：从服务器删除资源。
- PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

2、HTTP的第一行包含三个信息：谓词、URL、HTTP协议版本。三个数据使用空格隔开

POST http://comet.chouti.com/comet/connect HTTP/1.1

1、谓词(POST)

WEB API就是使用谓词作为默认的路由方式，最常用的谓词有：POST\DELETE\PUT\GET，这四个谓词对应了“增、删、改、查”四个动作
其中，GET，DELETE不包含BODY，PUT,POST可以包含BODY

2、URl

网络上的资源一般都用一段url代替,比如：http://www.chnsys.com/asset 代替资产资源

3、HTTP协议版本

HTTP的第一行内容就是这些: POST http://comet.chouti.com/comet/connect HTTP/1.1
接下来会有一个\r\n来进行换行，接下来就是HTTP HEAD部分，HTTP HEAD描述了HTTP请求和响应。
HTTP HEAD即为HTTP协议中最重要的部分，他包含了编码、BODY长度、内容协商等信息，你也可以包含一些自定义信息

3、RestFul API中常用的HEAD信息

User-Agent:用户代理，是什么客户端发出的请求，如IE、Chrome、Fiddler等
HOST:域名
Authorization：验证信息
Accept：接受何种序列化方式返回的数据，用MIME表示，用于对响应数据的内容协商，可以包含多个MIME，按优先顺序排列，如application/json，application/xml，text/html
Content-Type:使用一个MIME表示，表示所发送请求的Body的序列化方式，常见的application/json，
还有WEB交互最常使用的application/x-www-form-urlencoded，都表示了你的body部分的序列化方式，在请求、响应中都会出现
HTTP HEAD部分是HTTP协议中最核心的部分，可配置向非常多这里就不列举了
响应部分也分为头部和Body，响应头部和请求头部最大的不同在于响应首行存在一个HTTP Code HTTP Code作为API的调用状态的展示，也很重要，在REST API中最常用的状态码一般为2XX,4XX,5XX三个段
在首部之后有一个空行（\r\n）接下来就是Content，这里有具体的业务数据，根据不同的Content-Type使用不同的序列化方式表示，例如JSON，XML，甚至HTML

4、用一张图为大家展示一下这些知识

在这里插入图片描述

二. RestfulAPI使用举例

1、创建django项目testRestfulAPI

urls.py：

from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^asset/', views.AssetView.as_view()),
]

views.py：

from django.shortcuts import HttpResponse
from django.views import View
import json

class AssetView(View):
    def get(self,request):                # 返回查询信息
        print('response_select',request.META.get('HTTP_HOSTNAME'))     # c1.com
        return HttpResponse(json.dumps({'status':'ok','method':'select'}))

    def post(self,request):              # 创建
        print('response_create',request.body)     # {"hostname": "c1.com"}
        return HttpResponse(json.dumps({'status':'ok','method':'create'}))

    def put(self,request):              # 更新
        print('response_update',request.body)     # {"hostname": "c1.com"}
        return HttpResponse(json.dumps({'status':'ok','method':'update'}))

    def delete(self,request):          # 删除
        print('response_delete',request.body)     # {"hostname": "c1.com"}
        return HttpResponse(json.dumps({'status':'ok','method':'delete'}))

2、创建文件test.py使用requests模块模拟增删改查（注释服务器端csrf）

test.py：

import requests

# 1、查询
response_select = requests.get('http://127.0.0.1:8000/asset/',
                        headers={'hostname':'c1.com'},
                        )
print('response_select',response_select.json())      # {'method': 'select', 'status': 'ok'}

# 2、创建
response_create = requests.post('http://127.0.0.1:8000/asset/',
                        headers='',
                        json={'hostname':'c1.com'}
                        )
print('response_create',response_create.json())      # {'status': 'ok', 'method': 'create'}

# 3、更新
response_put = requests.put('http://127.0.0.1:8000/asset/',
                        headers='',
                        json={'hostname':'c1.com'}
                        )
print('response_update',response_put.json())         # {'method': 'update', 'status': 'ok'}

# 4、删除
response_delete = requests.delete('http://127.0.0.1:8000/asset/',
                        headers='',
                        json={'hostname':'c1.com'}
                        )
print('response_delete',response_delete.json())     # {'status': 'ok', 'method': 'delete'}