django+drf+swagger写一个后端框架demo
时间: 2023-10-09 21:13:31 浏览: 210
好的,下面是一个使用 Django、Django REST framework 和 Swagger 的后端框架 demo。
首先,需要安装 Django、Django REST framework 和 Swagger:
```
pip install Django
pip install djangorestframework
pip install django-rest-swagger
```
接着,创建一个 Django 项目:
```
django-admin startproject demo
```
然后,在项目根目录下创建一个名为 `api` 的 Django app:
```
cd demo
python manage.py startapp api
```
接下来,修改 `demo/settings.py` 文件,将 `api` app 添加到 `INSTALLED_APPS` 列表中:
```python
INSTALLED_APPS = [
# ...
'rest_framework',
'rest_framework_swagger',
'api',
]
```
然后,在 `api` app 下创建一个名为 `views.py` 的文件,用于编写 API 视图函数:
```python
from rest_framework.decorators import api_view
from rest_framework.response import Response
@api_view(['GET'])
def hello(request):
"""
返回一个简单的字符串
"""
return Response("Hello, world!")
```
接着,在 `api` app 下创建一个名为 `urls.py` 的文件,用于配置 API 路由:
```python
from django.urls import path
from rest_framework_swagger.views import get_swagger_view
from . import views
schema_view = get_swagger_view(title='API文档')
urlpatterns = [
path('', schema_view),
path('hello/', views.hello),
]
```
最后,修改 `demo/settings.py` 文件,设置 REST framework 和 Swagger 的配置:
```python
REST_FRAMEWORK = {
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
}
SWAGGER_SETTINGS = {
'SECURITY_DEFINITIONS': {
'Basic': {
'type': 'basic'
}
},
}
```
现在,运行 Django 项目:
```
python manage.py runserver
```
在浏览器中访问 `http://127.0.0.1:8000/api/`,即可看到 Swagger 的 API 文档界面。在其中可以看到一个名为 `hello` 的 API,点击该 API 可以进行测试,测试结果将会返回一个字符串 "Hello, world!"。
这就是使用 Django、Django REST framework 和 Swagger 编写的一个后端框架 demo。
阅读全文