drfyasg文档中添加示例的检查器
drf-yasg-examples的Python项目详细描述
在您的swagger文档中添加示例值！在
要求
- Python 3.6.1或更高版本
- 基于drf-yasg的代码库
安装
有pip
pip install drf-yasg-examples
用诗歌
^{pr2}$配置
编辑django配置文件。在
SWAGGER_SETTINGS={'DEFAULT_AUTO_SCHEMA_CLASS':'drf_yasg_examples.SwaggerAutoSchema',}
注意：如果您使用SwaggerAutoSchemaclass其他代码，请一起替换它们
使用
ChoiceField
在你的模型里写这样冗长的文字。在
classProduct(models.Model):CATEGORY=[('F','Food'),('L','Living Item'),]category=models.CharField(verbose_name='Category',max_length=1,choices=CATEGORY,)
ModelSerializer可能会将此字段设置为ChoiceField，而此包 在你的文档上自动写下enum k-v列表。在
其他
像这样在序列化程序类中编写示例值。在
classProductSerializer(serializers.ModelSerializer):classMeta:model=Productfields='__all__'example={'name':'Apple','amount':6,'price':'10.00',}
然后drfyasg会自动在你的文档上添加示例。在
许可证
麻省理工学院
- 项目
标签：
欢迎加入QQ群-->： 979659372
