DEV Community
·
使用@extend_schema_view自定义模式
💡
原文英文，约200词，阅读约需1分钟。
📝
内容提要
@extend_schema_view装饰器不影响视图逻辑，只用于自定义API文档。在/api/docs/中查看结果，可以搜索特定数据。代码示例展示如何用OpenApiParameter类定义参数，如'tags'和'ingredients'，用于过滤API请求。此装饰器扩展了Django Rest Framework Spectacular自动生成的模式，允许在列表端点添加参数说明。
🎯
关键要点
- @extend_schema_view装饰器不影响视图逻辑，仅用于自定义API文档。
- 可以在/api/docs/中查看结果，并通过此功能搜索特定数据。
- 代码示例展示如何使用OpenApiParameter类定义参数，如'tags'和'ingredients'，用于过滤API请求。
- 此装饰器扩展了Django Rest Framework Spectacular自动生成的模式。
- list=extend_schema用于扩展列表端点的模式。
- parameters用于传递请求到该视图的列表API。
- OpenApiParameter类允许指定API请求中可接受参数的详细信息。
- 第一个参数'tags'用于指定过滤的参数名称。
- OpenApiTypes.STR表示参数类型为字符串。
- description用于帮助用户理解参数的用途。
➡️
