django-rest-swagger是一个用于记录和展示Django REST framework API的工具。它提供了一个可视化的界面,可以自动生成API文档,并且支持在线测试API。
具体来说,django-rest-swagger可以通过以下步骤来记录API:
settings.py
文件中添加rest_framework_swagger
到INSTALLED_APPS
列表中:INSTALLED_APPS = [
...
'rest_framework_swagger',
]urls.py
文件中添加rest_framework_swagger
的URL配置:from rest_framework_swagger.views import get_swagger_viewschema_view = get_swagger_view(title='API Documentation')
urlpatterns = [
...
path('api/docs/', schema_view),
]
/api/docs/
路径,就可以看到自动生成的API文档界面。在django-rest-swagger生成的API文档界面中,你可以看到每个API的详细信息,包括请求方法、URL、请求参数、响应数据等。你还可以在界面中进行API的测试,直接输入参数并发送请求,查看返回的结果。
推荐的腾讯云相关产品和产品介绍链接地址:
云+社区技术沙龙[第26期]
腾讯技术创作特训营第二季第4期
云+社区技术沙龙[第14期]
云+社区技术沙龙[第4期]
云+社区技术沙龙[第21期]
第四期Techo TVP开发者峰会
技术创作101训练营
领取专属 10元无门槛券
手把手带您无忧上云