restful API

最新推荐文章于 2024-06-19 23:22:10 发布
最新推荐文章于 2024-06-19 23:22:10 发布
阅读量82 收藏 1
点赞数
文章标签： json 数据库 python
原文链接：http://www.cnblogs.com/xuyaping/p/7308359.html
版权

1. 什么是REST

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

2. REST API 

 一、协议

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

二、域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。　　

https://example.org/api/
三、版本（Versioning）

应该将API的版本号放入URL。

https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

四、路径（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
五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

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

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

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：删除某个指定动物园的指定动物
六、过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

七、状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里。

八、错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}
九、返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
十、Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

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"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。　　

十一、其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

　　

 

3. REST API 接口开发

按照规则，不借助任何框架，根据不同的请求方式做出不同的处理，并且返回内容以及相应状态码

url(r'^servers.html$', views.servers),
url(r'^servers/(\d+).html$', views.servers_detail),
urls.py 
# http://127.0.0.1:8000/api/servers.html GET:   获取服务器列表
# http://127.0.0.1:8000/api/servers.html POST:  创建服务器
# http://127.0.0.1:8000/api/servers/1.html GET: 获取单条信息
# http://127.0.0.1:8000/api/servers/1.html DELETE: 删除单条信息
# http://127.0.0.1:8000/api/servers/1.html PUT: 更新
from django.http import JsonResponse
def servers(request):
    if request.method == 'GET':
        v = models.Server.objects.values('id','hostname')
        server_list = list(v)
        return JsonResponse(server_list,safe=False)
    elif request.method == 'POST':
        # request.POST.get('...')
        # models.Server.objects.create(。。。。、)
        return JsonResponse(status=201)

def servers_detail(request,nid):
    if request.method == 'GET':
        obj = models.Server.objects.filter(id=nid).first()
        return HttpResponse('...')
    elif request.method == "DELETE":
        models.Server.objects.filter(id=nid).delete()
        return HttpResponse()
    elif request.method == 'PUT':
        request.body
        models.Server.objects.filter(id=nid).update()
views.py

 

 

4. 什么是 Django REST framework？

Django REST framework是一个基于Django开发的app，用于快速搭建REST API。

安装：

pip3 install djangorestframework

a. 快速使用

INSTALLED_APPS = [
    ...
    'rest_framework',
]
1.注册APP 
from rest_framework import routers
from . import views


router = routers.DefaultRouter()
router.register(r'users', views.UserInfoViewSet)

urlpatterns = [
    url(r'^', include(router.urls)),
]
2.注册路由 
from rest_framework import viewsets
from . import models
from . import serializers

# ########### 1. 基本处理方式 ###########

class UserInfoViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = models.UserInfo.objects.all().order_by('-id')
    serializer_class = serializers.UserInfoSerializer
3.编写ViewSet，视图函数 
from rest_framework import serializers
from . import models

class UserInfoSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.UserInfo
        # fields = ('id', 'username', 'pwd','ug') # fields = '__all__'
        exclude = ('ug',)
        depth = 1  # 0<=depth<=10
4.编写serializers，form验证以及数据库操作

PS：最终访问路径

[GET]          http://127.0.0.1:8000/api/users/
[POST]         http://127.0.0.1:8000/api/users/
[GET]          http://127.0.0.1:8000/api/users/7/
[PUT]          http://127.0.0.1:8000/api/users/7/
[DELETE]       http://127.0.0.1:8000/api/users/7/

b. 基于CBV

from django.conf.urls import url,include
from django.contrib import admin
from . import views

urlpatterns = [
    url(r'^users/$', views.UserList.as_view()),
    url(r'^users/(?P<pk>[0-9]+)/$', views.UserDetail.as_view()),
]
1.URL 
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework.parsers import JSONParser
from . import models
from . import serializers


class UserList(APIView):
    def get(self, request, *args, **kwargs):
        user_list = models.UserInfo.objects.all()
        serializer = serializers.MySerializer(instance=user_list, many=True)
        return Response(serializer.data)

    def post(self, request, *args, **kwargs):
        data = JSONParser().parse(request)
        serializer = serializers.MySerializer(data=data)
        if serializer.is_valid():
            # print(serializer.data)
            # print(serializer.errors)
            # print(serializer.validated_data)
            # 如果有instance，则执行update方法；否则，执行create
            serializer.save()
            return Response(serializer.data, status=201)
        return Response(serializer.errors, status=400)


class UserDetail(APIView):
    def get(self, request, *args, **kwargs):
        obj = models.UserInfo.objects.filter(pk=kwargs.get('pk')).first()
        serializer = serializers.MySerializer(obj)
        return Response(serializer.data)

    def delete(self, request, *args, **kwargs):
        obj = models.UserInfo.objects.filter(pk=kwargs.get('pk')).first()
        obj.delete()
        return Response(status=204)

    def put(self, request, *args, **kwargs):
        data = JSONParser().parse(request)
        obj = models.UserInfo.objects.filter(pk=kwargs.get('pk')).first()
        serializer = serializers.MySerializer(obj, data=data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=400)
2.编写视图函数 
from rest_framework import serializers
from rest_framework.exceptions import ValidationError
from . import models


class MySerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    username = serializers.CharField(required=False, allow_blank=True, max_length=100)
    pwd = serializers.CharField()

    def validate_username(self, value):
        if value == '中国':
            raise ValidationError('用户名中存在敏感字符')
        return value

    def validate_pwd(self, value):
        print(value)
        return value

    def validate(self, attrs):
        print(attrs)
        return attrs

    def create(self, validated_data):
        """
        当执行save方法时，自动调用。instance未传值
        :param validated_data:
        :return:
        """
        print(validated_data)
        return models.UserInfo.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        当执行save方法时，自动调用。instance传值
        :param instance:
        :param validated_data:
        :return:
        """
        instance.username = validated_data.get('username', instance.username)
        instance.save()
        return instance
3.编写serializers

c. 基于CBV

from django.conf.urls import url,include
from django.contrib import admin
from . import views

urlpatterns = [
    url(r'^users/$', views.user_list),
    url(r'^users/(?P<pk>[0-9]+)/$', views.user_detail),
]
1.URL 
from django.http import JsonResponse,HttpResponse
from rest_framework.response import Response
from rest_framework.parsers import JSONParser
from rest_framework.decorators import api_view
from .serializers import MySerializer
from . import models

@api_view(['GET',"POST"])
def user_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    if request.method == 'GET':
        user_list = models.UserInfo.objects.all()
        serializer = MySerializer(user_list,many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = MySerializer(data=data)
        if serializer.is_valid():
            print(serializer.data)
            print(serializer.errors)
            print(serializer.validated_data)
            # 如果有instance，则执行update方法；否则，执行create
            serializer.save()
            return Response(serializer.data, status=201)
        return Response(serializer.errors, status=400)

@api_view(['GET',"POST","PUT"])
def user_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """

    obj = models.UserInfo.objects.filter(pk=pk).first()
    if not obj:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = MySerializer(obj)
        # return JsonResponse(serializer.data,json_dumps_params={'ensure_ascii':False},content_type='application/json;charset=utf-8')
        return Response(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = MySerializer(obj, data=data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=400)

    elif request.method == 'DELETE':
        obj.delete()
        return Response(status=204)
2.视图函数 
from rest_framework import serializers
from rest_framework.exceptions import ValidationError
from . import models


class MySerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    username = serializers.CharField(required=False, allow_blank=True, max_length=100)
    pwd = serializers.CharField()

    def validate_username(self, value):
        if value == '中国':
            raise ValidationError('用户名中存在敏感字符')
        return value

    def validate_pwd(self, value):
        print(value)
        return value

    def validate(self, attrs):
        print(attrs)
        return attrs

    def create(self, validated_data):
        """
        当执行save方法时，自动调用。instance未传值
        :param validated_data:
        :return:
        """
        print(validated_data)
        return models.UserInfo.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        当执行save方法时，自动调用。instance传值
        :param instance:
        :param validated_data:
        :return:
        """
        instance.username = validated_data.get('username', instance.username)
        instance.save()
        return instance
3.编写serializers

d. 权限控制

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'permissi.MyPermission',
    ]
}
1.settings配置文件 
class MyPermission(object):
    """
    A base class from which all permission classes should inherit.
    """

    def has_permission(self, request, view):
        """
        Return `True` if permission is granted, `False` otherwise.
        """

        return True

    def has_object_permission(self, request, view, obj):
        return True
2.权限控制

 

 

 
 
 

转载于:https://www.cnblogs.com/xuyaping/p/7308359.html

anglu0752
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RESTful API设计规范.pdf
02-13
RESTful API设计规范.pdf RESTful API设计规范是指在软件架构和设计风格中，遵循一组设计原则和约束条件，以降低开发的复杂性，提高系统的可扩展性。RESTful架构的核心是面向资源，每个网址代表一种资源，因此网址...
restfull api 接口 规范
zhangbijun1230的专栏
03-11 1244
restfull api 接口 规范 1 这种接口 可以根据客户端 的要求类型返回不同的类型的 表现形式，比如返回json，返回xml，返回纯文本。 2 这种接口 不同的操作就得用不同的方法 get post delete put GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客...
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验
04-07
SpringBoot+Mybatis+CXF框架，实现Restful api与 WebService api接口的大实验 本实验的主要目标是使用SpringBoot、Mybatis和CXF框架来实现Restful API和WebService API接口的大实验。下面是实验的详细介绍： 标题...
采用Spring框架构建你的RestfulAPI
03-04
在构建基于Spring框架的RESTful API时，开发者可以利用Spring的强大功能来实现高效、安全且易于维护的后端服务。以下是一些关键知识点的详细解释： 1. **Spring Boot初始化Web应用** - **Maven依赖**：使用Spring ...
RESTFul API 接口说明
11-05
restful api 接口说明. 总结 restful api 语法知识和常用的状态码含义.
如何从零训练多模态大模型（预训练方向）
2201_75499313的博客
06-12 1363
参考 Finetune LLaVA on Custom Datasets[13]将训练样本以列表的形式保存到 json 文件，其中每一个样本是一个字典，它至少包含三个字段：id：全局唯一的字符串image：图片的路径，可以是绝对路径，也可以是相对于image_folder的相对路径conversations：人类和语言模型的对话},},},...完成数据的处理后，修改 finetune.sh[14] 中的 data_path 参数（必须）以及其他想要调整的参数（可选，例如学习率）。
Skype机器人
最新发布
Rsun2018的博客
06-19 33
这段代码实现了一个Skype机器人，能够处理新消息事件，根据消息历史生成适当的回复，并返回给用户。机器人使用OpenAI的GPT模型生成回复，确保在回复前结合相关的基督教文献和内容。
手机在网状态-手机在网状态查询-手机在网站状态接口
lupai的博客
06-14 646
查询手机号在网状态，返回正常使用、停机、未启用/在网但不可用、不在网（销号/未启用/异常）、预销户等多种状态 直连三大运营商，实时更新，可查询实时在网状态 高准确率-实时更新，准确率99.99%接口地址：https://www.wapi.cn/api_detail/120/263.html。s_msg 否 Integer 手机状态中文说明：正常、停机、在网不可用、销号、 查无信息 正常。红色部分代表参数值，appid默认为1，请修改为自己的appid值，去我的应用查看以及密钥。如何设置hash验证。
springboot项目中切数据库（mysql-＞ pg）带来的适配问题:typeHandler
dl425134845的专栏
06-18 579
以上写法，在mysql数据库中可以正常写入，但是在pg数据库是不行的，会报错，其实是pg数据库对json字段类型会进行强校验，所有只有自己复写saveOrUpdate方法；这里省略了创建时间和修改时间字段等，重点是要讨论permissions字段；注释掉this.saveOrUpdate(rolePermission);环境：springboot3.1.0。这里可以看到是用的pg数据库；
vscode编辑器警告， jsconfig.json 第一行红色波浪线
pacong的博客
06-11 221
项目是可以正常运行的，就是编辑器有个红色提示看着不顺眼。配置文件jsconfig.json。第一行总是有个，红色下划线。
oracle的json_arrayagg的用法和例子
codemami的博客
06-13 760
这个函数对于将查询结果转换为 JSON 格式特别有用，尤其是在 RESTful API 或需要 JSON 输出的应用中。NULL ON NULL：如果所有输入值都是 NULL，则返回 NULL（在 12c R2 及更高版本中可用）。STRICT：如果任何输入值不是有效的 JSON，则抛出异常（在 12c R2 及更高版本中可用）。PRETTY：美化输出的 JSON 格式（在 12c R2 及更高版本中可用）。expr：要聚合的表达式，可以是任何可以求值为 JSON 对象的表达式。
vue3+ts 使用vue3-ace-editor实现Json编辑器
x_nweBorder01k的博客
06-19 190
vue3+ts 使用vue3-ace-editor实现Json编辑器
Json和Protobuf区别详细分析
m0_68224121的博客
06-11 210
JSON和protobuf分析：首先，Json在windows平台或者是Linux平台提供了大量的API函数，方便直接对其进行使用。protobuf是谷歌开发的一种数据传输格式，比json的数据量更小，也更对象化。protobuf不是像JSON直接明文，这个是定义对象结构，然后由protobuf库去把对象转换成二进制，用的时候再自动反解过来的。传输对于我们来说是透明的，我们只管传输的对象就可以了。
uniapp 仿写弹窗
weixin_45881304的博客
06-13 606
【代码】uniapp 仿写弹窗。
各种文件类型
qq_43710593的博客
06-18 243
结尾的文件通常是指JavaScript Object Notation（JSON）格式的文件。JSON是一种轻量级的数据交换格式，易于人类阅读和编写，同时也易于机器解析和生成。Pickle是Python中的一个模块，用于将Python对象转换为字节流，以便保存到文件中或者通过网络传输。JSON格式具有跨平台和语言无关的优点，因此广泛应用于各种编程语言和系统中。需要注意的是，Pickle模块是Python特有的，因此。结尾的文件通常是指使用Python的。文件中，然后又从文件中加载回来。
vue3 中传递 fromData 格式的写法
阿乐的博客
06-19 90
在我们前端调用接口的使用中 我们会传递参数 大部分是json 格式的 但是有的时候 回事 formData 的格式的 那我们前端就需要修改一下 传递对应的东西。如果不传递 paramsFormdata 就默认是json 传就是formData 的格式的。我说一下我使用Taro 框架中的写法 就是移动端 和小程序中的写法。我这里有一个判断 当我需要传递这个 formData 的格式的时候。我说一下在web端中的使用 我使用的是tdesign 的框架。人家封装好的request 的文件我就不写了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值