path('docs/', include_docs_urls(title='API document')),
]
2.3 文档描述说明的定义位置
单一方法的视图,可直接使用类视图的文档字符串
class...])
urlpatterns = [
# drf认证
path(r'api-auth/', include('rest_framework.urls', namespace='rest_framework...P\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-spec'),
re_path(..., JSON 格式的 API 定义
/swagger.yaml, YAML 格式的 API 定义
/swagger/, 基于原生 swagger-ui 样式的前端页面
/redoc/, 基于 ReDoc...patterns: 自定义的urlpatterns, 该参数直接透传至SchemaGenerator
urlconf: 描述从哪个文件获取路由配置, 缺省值是urls, 该参数直接透传至SchemaGenerator