结合DRF框架提供标准RESTful API接口

最新推荐文章于 2023-12-15 17:20:54 发布
原创 最新推荐文章于 2023-12-15 17:20:54 发布 · 386 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文深入解析RESTful API的设计原则，涵盖请求方式、状态码、URL规范及参数传递，阐述了如何利用HTTP动词进行资源操作，并提供了常见状态码的含义说明。同时，文章通过实例展示了如何构建符合RESTful风格的API，包括过滤、排序和分页等高级功能。

RESTful不是一种技术，而是一种接口规范，主要规范包括：1.请求方式、2.状态码、3、url规范、4、传参规范

  • 请求方式method

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

  • 状态码

'''1. 2XX请求成功'''
# 200 请求成功，一般用于GET与POST请求
# 201 Created - [POST/PUT/PATCH]：用户新建或修改数据成功。
# 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
# 204 NO CONTENT - [DELETE]：用户删除数据成功。
'''2. 3XX重定向'''
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 临时重定向
'''3. 4XX客户端错误'''
# 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] 当创建一个对象时，发生一个验证错误。
'''4. 5XX服务端错误'''
# 500 INTERNAL SERVER ERROR - [*]：服务器内部错误，无法完成请求
# 501 Not Implemented     服务器不支持请求的功能，无法完成请求

  • 面向资源编程： 路径，视网络上任何东西都是资源，均使用名词表示（可复数）

    • 所有请求实际操作的都是数据库中的表，每一个表当做一个资源
    • 资源是一个名称，所以RESTful规范中URL只能有名称或名词的复数形式
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees

  • 过滤，通过在url上传参的形式传递搜索条件

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

  • django的DRF
    参考链接

    • 认证
    • 权限
    • 序列化
    • 版本号
    • 限流

更具体可参考：参考链接

Hanmin_hm
关注
【Django-DRF框架】生成各种API接口文档
python全栈
05-21 1253
方式一： 安装 pipenv install coreapi pipenv install Pygments pipenv install Markdown 配置 REST_FRAMEWORK = { ...... #指定用于支持coreapi的Schema 'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.coreapi.AutoSchema' } 在全局路由条目中，定义路由条目 from rest_framework.documen
DRF+Vue.JS前后端分离项目实例(上)：使用 Django-Rest-Framework快速实现 RESTful API 接口编程
Python技术探索
07-06 6956
django-rest-framework (简称**DRF**) 继承了django框架的上述优点，开发与部署不需要第3方库的支持就可以轻松完成数据库CRUD的 REST API开发，并提供完善的鉴权、分级权限控制、测试页面等功能，可以快速地开发出一套高质量的REST API。 本文演示了学生信息查询项目的API接口设计，django-rest-framework函数式编程，CBV视图类编程两种方式实现API， 最后介绍了DRF的页面测试功能
接口、RESTful规范、DRF
dd345898084的博客
05-15 171
接口 #接口：url连接，通过向链接发送不同的类型请求与参数得到相应的响应数据 #1.在视图书写处理请求的 视图函数 #2.在路由层为视图函数配置 url链接=>产生接口 #3.前台通过ajax，爬虫，工具等对接口发送请求，提交相应的参数获得对应的响应数据 # https://api.map.baidu.com/place/v2/search ''' ak: 6E...
django restframework restful 风格接口
ZhuDaoKe的博客
03-01 904
restful 风格接口 -DRF 是风格 不是标准 http、https协议 传输数据类型 json url : 单独的url 比如 http://api.douban.com 或者说 http://www.douban.com/api/ 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般...
DRF自动生成API方法--coreapi
passion
12-04 3818
DRF 自动生成API # pip install coreapi from django.urls import path from rest_framework.documentation import include_docs_urls urlpatterns = [ # 如果存在权限的问题，加上 authenticatio...
DRF使用超链接API实现真正RESTful
kokang88的博客
12-21 351
很多API并不是真正的实现了RESTful，而应该叫做RPC (Remote Procedure Call 远程过程调用)，Roy Fielding曾经提到了它们的区别，原文如下： I am getting frustrated by the number of people calling any HTTP-based interface a REST API. Today’s example is the SocialSite REST API. That is RPC. It screams RPC.
DRF从入门到精通一（DRF介绍、API接口、接口测试工具、Restful规范、序列化反序列化、基于drf、原生编写接口，APIView源码分析）
Mchen的博客
12-15 5456
大体流程就是：前端在编写完静态页面之后，需要发送给后端人员做二次处理，所有的html代码和数据在服务器拼接好，等前后端处理好模版之后在做整合，然后一次性将所有内容发送到客户端，浏览器执行代码，将内容呈现给客户。，后端人员向前端开放数据接口(路由)，视图层不在直接返回给浏览器了，而是与前端做起了数据交互，实际上返回界面的还是前端，前端工作人员调用接口获取数据，从而将数据显示到页面。主要功能是发送http请求。Apifox也是一款接口调试工具，也是免费的可视化软件，相较而言我觉得是比Postman更好用一下。
掌握Python DRF框架，实现RESTful API开发五阶段教程
2. 创建API视图：在Django中创建API视图是使用DRF框架的基础。视图（View）在Django中负责处理请求（request），并返回响应（response）。DRF允许开发者使用APIView类来创建视图，这个类已经包含了处理各种HTTP请求...
基于DRF框架的扫码支付接口设计源码
最新发布
10-01
DRF框架作为一个强大的后端开发框架，它以Django为核心，专注于构建RESTful API，因此非常适合用于构建扫码支付接口。在这个项目中，DRF框架被用来处理后端逻辑，比如验证、授权、数据处理等，以及生成支付接口的...
Python利用Django如何写restful api接口详解
09-20
当我们需要构建RESTful API接口时，Django结合Django REST framework（DRF）是一个理想的选择。RESTful API设计遵循资源导向的原则，通过HTTP方法（GET、POST、PUT、DELETE等）来操作资源，使得接口清晰、可扩展且...
DRF开发RESTful API接口
qq_43401941的博客
10-08 806
上一篇：[https://blog.youkuaiyun.com/qq_43401941/article/details/108962767])(https://blog.youkuaiyun.com/qq_43401941/article/details/108962767) DRF的认证和权限 九、认证方式的介绍 用户名和密码认证（BasicAuthentication）【用于测试工作，尽量不要用于生产环境】 Session认证（SessionAuthentication） Token认证（TokenAuthenticati
DRF简介
Jaylen1997的博客
02-04 2955
Django REST Framework的介绍及安装 Django REST framework (DRF)是基于Django实现的一个RESTful风格API框架，能够帮助我们快速开发RESTful风格的API，文档地址如下所示: 官网：https://www.django-rest-framework.org/ 中文文档：https://q1mi.github.io/Django-REST-framework-documentation/ DRF可以使用pip安装，安装前请确保你已经安装了Django
Django Restful（DRF）框架学习（二）第一个API接口
chinaltx的博客
02-08 1142
一、初始化项目 创建应用：python manage.py startapp api 在settings.py中的INSTALLED_APPS列表下添加APP INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'djan...
从小白到高手---api接口和drf（Django Rest_Framework)使用超详解
wangfan741的博客
10-27 5724
drf（Django Rest_Framework)笔记 1.api接口 为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。 目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。 rpc: 翻译成中文:远程过程调用[远程服务调用]. http://www.lufei.com/api post请求 action=get_all_student&params=3
DRF快速开发基本API接口
xmt970324的博客
11-13 1295
1.创建模型操作类 from django.db import models class Teacher(models.Model): SEX_OPTION = ( (0, "男"), (1, "女"), ) name = models.CharField(max_length=20, verbose_name='姓名') age = models.SmallIntegerField(verbose_name="年龄") sex =
搭建第一个DRF-api接口
前端小东
09-24 513
安装好所有的环境后，我们来写一个drf的基本接口 1：准备好数据model students下的models.py from django.db import models # Create your models here. class Student(models.Model): name = models.CharField(null=False, max_length=32, verbose_name='姓名') sex = models.BooleanField(default=T
drf-yasg 用法
热门推荐
lmz_lmz的博客
07-10 1万+
用法0.安装首选的安装方法直接来自pypi：pip install drf-yasg 此外，如果要使用内置验证机制（请参阅4.验证），则需要安装一些额外要求：pip install drf-yasg[validation] 1.快速入门在settings.py：INSTALLED_APPS = [ ... 'drf_yasg', ... ] 在urls.py：... from d...
统一资源返回结果集
snow_5的博客
12-13 1412
在后端获取到数据后返回一个统一的样式返回给前端 package com.guli.common.entity; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.HashMap; import j...
将python webapi部署到服务器
lidongxx的博客
06-21 4168
创建一个Dockerfilepy文件 FROM python COPY ./ /app/ WORKDIR /app/ RUN pwd RUN ls -al RUN pip install flask RUN pip install numpy RUN pip install urllib3 RUN pip install sklearn USER root EXPOSE 自己定对外的端口 ENT...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值