如何在Django REST Framework的API根页面添加函数式API
要将Django的函数式API添加到rest_framework的API根页面,您可以使用@api_view装饰器和@renderer_classes装饰器来定义您的视图函数,并将其添加到API根视图中。
以下是一个完整的例子:
- 首先,您需要安装
djangorestframework库,以便使用API框架。
pip install djangorestframework
- 然后,在您的Django项目中,创建一个名为
views.py的文件,并定义您的视图函数,例如:
from rest_framework.decorators import api_view, renderer_classes
from rest_framework.renderers import JSONRenderer
@api_view(['GET'])
@renderer_classes([JSONRenderer])
def my_api(request):
data = {'message': 'Hello, World!'}
return Response(data)
这个视图函数使用@api_view装饰器将其转换为API视图,并使用@renderer_classes装饰器指定JSON渲染器。
- 接下来,在您的Django项目中,打开
urls.py文件,并将您的视图函数添加到API根视图中,例如:
from django.urls import path, include
from rest_framework import routers
from . import views
router = routers.DefaultRouter()
router.register(r'my_api', views.my_api)
urlpatterns = [
path('', include(router.urls)),
]
这将创建一个名为my_api的API视图,并将其添加到API根视图中。
- 最后,在您的Django项目中,启用API框架,例如:
INSTALLED_APPS = [
# ...
'rest_framework',
# ...
]
现在,您可以通过访问API根视图来查看您的my_api函数,例如:
http://localhost:8000/
这将显示API根页面,并列出您的my_api函数。单击链接以查看函数的输出。
原文地址: https://www.cveoy.top/t/topic/lo5M 著作权归作者所有。请勿转载和采集!