【DRF】快速入门,使用DjangoRestFrameWork自动生成Restful风格的增删改查代码和接口文档!
DRF快速入门
⭐都快2023年了还有人自己写增删改查代码?!?我不允许还不会有人用DRF!
⭐今天教大家使用 Django Rest FrameWork 自动生成Restful风格的增删改查代码和接口文档!
⭐参考文章:首页 - Django REST 框架 (django-rest-framework.org)(官方文档)
- 注意:
- Django Rest FrameWork 是在Django框架下使用
- 以下内容需要先创建一个Django项目
- 什么是Restful风格:RESTful API 一种流行的 API 设计风格
安装依赖
安装
Rest FrameWork 需要满足以下条件:
- Python (3.6, 3.7, 3.8, 3.9, 3.10)
- Django (2.2, 3.0, 3.1, 3.2, 4.0, 4.1)
1 | # 安装Django |
设置
- 以下内容在项目中
seeting.py
配置
1 | INSTALLED_APPS = [ |
快速使用
配置models
- 以下内容在 app 中的
models.py
配置
1 | from django.db import models |
- 配置好models记得迁移数据库
1 | python manage.py makemigrations |
配置serializers
- 以下内容在app中新建
serializers.py
目录
1 | from rest_framework import serializers |
配置view
- 以下内容在app中
views.py
配置
1 | from rest_framework.viewsets import ModelViewSet |
配置url
- 以下内容在app目录下
urls.py
配置
1 | from django.urls import path |
- 以下内容在项目目录下
urls.py
配置
1 | from django.contrib import admin |
配置seetings
- 以下内容在项目目录下
seetings.py
配置
1 | # 配置默认API文档 |
启动项目
1 | # 直接启动项目就可用访问啦 |
- http://127.0.0.1:8000/stu/ 访问apiroot界面
- http://127.0.0.1:8000/stu/students/ 访问对数据库学生的操作界面
- http://127.0.0.1:8000/stu/docs/ 访问接口文档
页面预览:
接口文档
api管理页面
⭐以上就是一些基础的配置内容啦!基础的CURD代码已经生成完毕!
⭐当然DRF还可以配置的东西非常多 JWT,分页… (之后的文章会介绍到)
⭐以上内容只是快速的配置 全面API请查阅官方文档:首页 - Django REST 框架 (django-rest-framework.org)
⭐如果对你有帮助请给我点个赞吧
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 雪人的小屋!
评论