RESTful API

最新推荐文章于 2024-10-11 10:31:29 发布
最新推荐文章于 2024-10-11 10:31:29 发布
阅读量57 收藏
点赞数
分类专栏： Django 文章标签： Django Restful API
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/luan7liem/article/details/88089220
版权

简介

  • REST与技术无关，代表的是一种软件架构风格,REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • 所有的数据，不管是通过网络获取的还是操作数据库获得（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性

一.API

1、什么是API？
答:API就是接口，提供的url。接口有两个用途：

  1. 为别人提供服务
  2. 前后端分离，一个写vue，一个写后端，他们之间都是通过ajax请求

二.RESTful API设计

  1. 协议
    API与用户的通信协议，总是使用HTTPs协议。

  2. 域名
    方式一:尽量将API部署在专用域名（会存在跨域问题）: https://api.example.com
    方式二:如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下:https://example.org/api/

  3. 版本（Versioning）
    应该将API的版本号放入URL:https://api.example.com/v1/
    另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。

  4. 路径（Endpoint）
    路径又称"终点"（endpoint），表示API的具体网址。在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
    举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。
    https://api.example.com/v1/zoos
    https://api.example.com/v1/animals
    https://api.example.com/v1/employees

  5. HTTP动词

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

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
  1. 过滤信息（Filtering）
    如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。下面是一些常见的参数。
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
  1. 状态码（status codes）
200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
  1. 错误处理（Error handling）
    如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
{
    error: "Invalid API key"
}
  1. 返回结果
    针对不同操作，服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
  1. Hypermedia API 超媒体API
    RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
    比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。
{"link": {
  "rel":   "collection https://www.example.com/zoos",  #表示这个API与当前网址的关系（collection关系，并给出该collection的网址）
  "href":  "https://api.example.com/zoos",  #API路径
  "title": "List of zoos",  #API的标题
  "type":  "application/vnd.yourformat+json"  #返回类型
}}

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

三、基于Django实现API

  • 方式一:FBV
    1.全局url
from django.contrib import admin

from django.conf.urls import url, include
from app01 import views
from app02 import views

urlpatterns = [
    url('admin/', admin.site.urls),
    # path('hosts/',views.HostView.as_view()),
    url('app02/', include('app02.urls'))
]

2.app02/url

from app02 import views
from django.conf.urls import url
urlpatterns = [
    url('^users/', views.users),
    url('^user/(\d+)', views.user),

    url('^users/', views.UsersView.as_view()),
    url('^user/', views.UserView.as_view()),
]

3.views

from django.shortcuts import render,HttpResponse

# Create your views here.
import json

def users(request):
    response = {'code':1000,'data':None}  #code用来表示状态，比如1000代表成功，1001代表
    response['data'] = [
        {'name':'haiyan','age':22},
        {'name':'haidong','age':10},
        {'name':'haixiyu','age':11},
    ]
    return HttpResponse(json.dumps(response))  #返回多条数据

def user(request,pk):
    if request.method =='GET':
        return HttpResponse(json.dumps({'name':'haiyan','age':11}))  #返回一条数据
    elif request.method =='POST':
        return HttpResponse(json.dumps({'code':1111}))  #返回一条数据
    elif request.method =='PUT':
        pass
    elif request.method =='DELETE':
        pass
  • 方式二:CBV模式
    1.app02/urls
from app02 import views
from django.conf.urls import url
urlpatterns = [
     url('^users/', views.UsersView.as_view()),
     url('^user/', views.UserView.as_view()),
 ]

2.views

from django.views import View
class UsersView(View):
    def get(self,request):
        response = {'code':1000,'data':None}
        response['data'] = [
            {'name': 'haiyan', 'age': 22},
            {'name': 'haidong', 'age': 10},
            {'name': 'haixiyu', 'age': 11},
        ]
        return HttpResponse(json.dumps(response),stutas=200)

class UserView(View):
    def get(self,request,pk):
        return HttpResponse(json.dumps({'name':'haiyan','age':11}))  #返回一条数据
    def post(self,request,pk):
        return HttpResponse(json.dumps({'code':1111}))  #返回一条数据
    def put(self,request,pk):
        pass
    def delete(self,request,pk):
        pass

基于django实现的API许多功能都需要我们自己开发，这时候djangorestframework就给我们提供了方便，直接基于它来返回数据，总之原理都是一样的，就是给一个接口也就是url，让前端的人去请求这个url去获取数据，在页面上显示出来。这样也就达到了前后端分离的效果。下面我们来看看基于Django Rest Framework框架实现

四、基于Django Rest Framework框架实现

  1. 自定义认证规则
class MyAuthtication(BasicAuthentication):
    def authenticate(self, request):
        token = request.query_params.get('token')  #注意是没有GET的，用query_params表示
        if token == 'zxxzzxzc':
            return ('uuuuuu','afsdsgdf') #返回user，auth
        raise APIException('认证错误')

class UserView(APIView):
    authentication_classes = [MyAuthtication,]
    def get(self,request,*args,**kwargs):
        print(request.user)
        print(request.auth)
        return Response('用户列表')

应用：主要是做Token验证 url中as_view里面调用了dispatch方法。
可以有两种方式:

  • 局部使用:urls
from app01 import views
from django.conf.urls import url
urlpatterns = [
    # django rest framework
    url('^hosts/', views.HostView.as_view()),
    url(r'^auth/', views.AuthView.as_view()),
]
  • 局部使用:views
from django.shortcuts import render,HttpResponse
# Create your views here.
from rest_framework.views import  APIView
from rest_framework.views import Request
from rest_framework.authentication import SessionAuthentication
from rest_framework.authentication import BaseAuthentication, BasicAuthentication
from rest_framework.parsers import JSONParser
from rest_framework.negotiation import  DefaultContentNegotiation
from rest_framework.exceptions import APIException
from app01 import models
from rest_framework.response import Response  #友好的显示返回结果



class AuthView(APIView):
    #auth登录页面不需要验证，可设置
    authentication_classes = []  #登录页面不需要认证
    def get(self,request):
        '''
        接收用户名和密码
        :param request:
        :return:
        '''
        ret = {'code':1000,'msg':None}
        user = request.query_params.get('username')

        pwd = request.query_params.get('password')
        print(user,pwd)
        obj = models.UserInfo.objects.filter(username=user,password=pwd).first()
        print(obj)
        if not obj :
            ret['code'] = 1001
            ret['msg'] = '用户名或者密码错误'
            return Response(ret)
        #创建随机字符串
        import time
        import hashlib
        ctime = time.time()
        key = '%s|%s'%(user,ctime)
        m = hashlib.md5()
        m.update(key.encode('utf-8'))
        token = m.hexdigest()

        #保存数据
        obj.token = token
        obj.save()

        ret['token'] = token
        return Response(ret)

class HostView(APIView):
    def dispatch(self, request, *args, **kwargs):
        return super().dispatch(request, *args, **kwargs)

    # authentication_classes = [MyAuthtication]

    def get(self,request,*args,**kwargs):
        print(request.user,'dddddddddddffffff')
        print(request.auth,'dddddddddd')
        #原来的request，django.core.handlers.wsgi.WSGIRequest
        #现在的request ,rest_framework.request.Request
        # print(request)
        authentication_classes = [SessionAuthentication,BaseAuthentication]
        # print(self.authentication_classes)  # [<class 'rest_framework.authentication.SessionAuthentication'>,
                                            #  <class 'rest_framework.authentication.BasicAuthentication'>]
        return HttpResponse('GET请求的响应内容')

    def post(self,request,*args,**kwargs):
        pass
        # try:
        #     try :
        #         current_page = request.POST.get("page")
        #
        #         current_page = int(current_page)
        #         int("asd")
        #     except ValueError as e:
        #         print(e)
        #         raise #如果有raise说明自己处理不了了，就交给下面的一个去捕捉了
        # except Exception as e:
        #     print("OK")


        return  HttpResponse('post请求的响应内容')

    def put(self, request, *args, **kwargs):
        return HttpResponse('put请求的响应内容')
  • 全局使用:settings
#注册认证类
REST_FRAMEWORK = {
    'UNAUTHENTICATED_USER': None,
    'UNAUTHENTICATED_TOKEN': None,  #将匿名用户设置为None
    "DEFAULT_AUTHENTICATION_CLASSES": [
        "app01.utils.MyAuthentication",
    ],
}
  • 全局使用:views
from  rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import APIException
from app02 import models


class MyAuthentication(BaseAuthentication):
    def authenticate(self, request):
        token=request.query_params.get('token')
        print(token)
        obj=models.UserInfo.objects.filter(token=token).first()
        print(obj)
        if obj:
            return (obj.username,obj)
        raise  APIException('没有通过验证')

注：rest_framewor是一个app需要settings里面设置。

Petrus_shuai
关注
专栏目录
Python Flask高级编程之RESTFul API前后端分离精讲第七章节
03-19
Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API前后端分离精讲第六章节Python Flask高级编程之RESTFul API...
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验
04-07
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验 本实验的主要目标是使用SpringBoot、Mybatis和CXF框架来实现Restful API和WebService API接口的大实验。下面是实验的详细介绍： 标题...
Restful API优雅原则统一规范
热门推荐
张彦峰的博客
10-14 4万+
本部分预留作业，后续总结后分享。
Restful API
最新发布
weixin_46598480的博客
10-11 1339
REST API 定义如下：一种应用程序编程接口（API 或 Web API），遵循一组关于应用程序如何使用 HTTP 方法相互通信的架构规则。RESTful Web 服务使用 REST API 协议，因此有时也称为 RESTful API。REST 通常用于构建 Web API，允许客户端与服务器之间通过 HTTP 协议进行交互。REST 是由 Roy Fielding 在 2000 年提出的一种架构风格。
restful api
fanzhe的博客
11-14 251
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）GET（SELECT）：从服务器取出资源（一项或多项）POST（CREATE）：在服务器新建一个资源。DELETE（DELETE）：从服务器删除资源。patch方法用来更新局部资源。put方法用来更新全部资源。
RESTful api
qq_40407998的博客
10-28 2809
官网 https://restfulapi.cn/ REST 是 Representational State Transfer的缩写，如果一个架构符合REST原则，就称它为RESTful架构 使用原因：RESTful 架构可以充分的利用 HTTP 协议的各种功能，是 HTTP 协议的最佳实践 RESTful API 是一种软件架构风格、设计风格，可以让软件更加清晰，更简洁，更有层次，可维护性更好 API 请求 1. HTTP 动词 GET： 读取（Read） POST： 新建（Create） PUT
RESTful API设计指南：构建高效、可扩展和易用的API
weixin_73588491的博客
07-20 3972
RESTful API（Representational State Transfer API），中文翻译过来可以表述为表述性状态转移，是一种基于HTTP协议的网络应用程序接口风格。它遵循REST架构风格的约束条件和原则，以资源为中心，使用标准的HTTP方法（如GET、POST、PUT、DELETE等）来执行操作。RESTful API强调简单性、可扩展性和可读性，使得不同系统之间的通信变得更加直观和高效。设计高质量的 RESTful API 是一个持续的过程。
详解 restful API
weixin_53156345的博客
05-15 2998
​ 服务器不能保存客户端的信息，每一次从客户端发送的请求中，要包含所有必须的状态信息，会话信息由客户端保存，服务器端根据这些状态信息来处理请求，当客户端可以切换到一个新状态的时候发送请求信息，当一个或者多个请求被发送之后，客户端就处于一个状态变迁过程中。从请求方式上无法知道API是干嘛的，素有在URL上都会有操作的动词来表示API进行的动作，例如：query，add，update，delete等等。安全性是指：方法不会修改资源状态，朗读的为安全的，写的操作为非安全的。
Restful API实现
weixin_38672188的博客
02-08 751
Restful API实现 Restful API 风格的API请求与常规请求区别 （1）我们使用的是@RestController这个注解，而不是@Controller，不过这个注解同样不是Spring boot提供的，而是Spring MVC4中的提供的注解，表示一个支持Restful的控制器。 （2）这个类中有三个URL映射是相同的，即都是/restful/{id}，这在@Controller标识的类中是不允许出现的。这里的可以通过method来进行区分，produces的作用是表示返回结
Restful API规范
00后的程序员
01-07 1万+
RESTful API 是应用程序接口 (API) 的一种架构风格，它使用 HTTP 请求来访问和使用数据。该数据可用于数据类型，这些数据类型是指有关资源的操作的读取、更新、创建和删除。（也称为 RESTful Web 服务或 REST API）基于表示(REST)，它是。
RESTful API 设计规范
sheji888的专栏
05-27 958
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。RESTful API 设计规范旨在提供一种简单、灵活、可伸缩的通信方式，它基于资源的设计风格，并通过标准的HTTP方法（如GET、POST、PUT、DELETE）对资源进行操作。版本：可以将版本号放在HTTP头信息中，也可以放入URL中，如https://api.XXXXXX.com/v1/，或者加入参数中。命名规范：尽量使用资源的名词来命名 URI，而不是动词。
RESTfulAPI:.net 5构建RESTful API，杨旭学习编码和笔记
03-07
在.NET 5中构建RESTful API是现代Web服务开发中的常见任务，这主要得益于REST（Representational State Transfer）架构风格的广泛采纳。RESTful API设计原则强调资源的表述和状态转移，通过HTTP协议来实现客户端与...
c c++实现http服务 c c++开发restful api服务
02-11
本文将深入探讨如何使用C和C++来实现HTTP服务，并开发RESTful API服务器。 首先，HTTP（超文本传输协议）是互联网上应用最为广泛的一种网络协议，用于从万维网服务器传输超文本到本地浏览器。它是一个基于请求与...
表单提交按钮的三种区别
Petrus
05-25 2920
关于表单提交按钮的三种区别: <input type="button" value="input-button"> 不会触发form表单的默认提交事件 所以基于Ajax提交表单数据 建议选用此种方式 <input type="submit" value="submit"> 会触发form表单的默认提交事件 <button>button</butt...
django模型中auto_now和auto_now_add的区别
Petrus
03-17 1018
对于auto_now=False和auto_now_add=False。由于开始不太清楚这两个属性的作用，于是费了不少时间才查到这里的问题。两者默认值都为False。 auto_now=Ture，字段保存时会自动保存当前时间，但要注意每次对其实例执行save()的时候都会将当前时间保存，也就是不能再手动给它存非当前时间的值。 auto_now_add=True，字段在实例第一次保...
前端提交的三种数据格式后端处理
Petrus
07-12 429
1.form-data： post提交的数据，从request.POST中取 2. x-www-form-urlencoded:从request.POST中取 3. json:提交的数据从request.body中提取
Django中null和blank的区别
Petrus
12-05 382
字段选项——null 如果为True，Django将用NULL来在数据库中存储空值 默认值:False 字段选项——blank 如果为True , 该字段允许不填 默认值:False null是纯数据库范畴，而blank是数据验证范畴的 blank=True，表单验证允许该字段为空 blank=False，该字段就是必须的 ...
RESTful API设计指南
"RESTful API设计规则书，作者Mark Massé，详细讲述了如何设计RESTful API。" 本书《RESTful API设计规则书》是Mark Massé的作品，主要关注于RESTful API的设计方法。REST（Representational State Transfer）是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值