在restframework中添加对api返回字段的限制

django-returnfields的Python项目详细描述


https://travis-ci.org/podhmo/django-returnfields.svg

在restframework中添加对api返回字段的限制。

这是什么?

api的定义如下

request: GET /users/1/?format=json
status code: 200
response: {
  "id": 1,
  "url": "http://testserver/users/1/?format=json",
  "username": "foo",
  "email": "",
  "is_staff": false,
  "skills": [
    {
      "id": 1,
      "user": 1,
      "name": "magic"
    },
    {
      "id": 2,
      "user": 1,
      "name": "magik"
    }
  ]
}

如果传递return_fields选项,则过滤api的响应

request: GET /users/1/?format=json&return_fields=username,id
status code: 200
response: {
  "id": 1,
  "username": "foo"
}

并添加跳过字段选项,作为忽略字段处理。

request: GET /users/1/?format=json&return_fields=username,skills&skip_fields=skills__id,skills__user
status code: 200
response: {
  "username": "foo",
  "skills": [
    {
      "name": "magic"
    },
    {
      "name": "magik"
    }
  ]
}

如何使用?

使用django_returnfields.serializer_factory

fromrest_frameworkimportviewsetsfromdjango_returnfieldsimportserializer_factoryclassUserViewSet(viewsets.ModelViewSet):queryset=User.objects.all()serializer_class=serializer_factory(UserSerializer)

附录

如果使用aggressive选项请求,则django_returnfields会尝试使用Query.defer()Query.only()。 例如

GET /users/1/?format=json&return_fields=username,skills&skip_fields=skills__id,skills__user&aggressive=1

aggressive选项不仅使用defer和only,而且还使用半自动连接或预取(TODO:introduction)

示例

## modelsfromdjango.dbimportmodelsfromdjango.contrib.auth.modelsimportUserclassSkill(models.Model):name=models.CharField(max_length=255,default="",null=False)user=models.ForeignKey(User,null=False,related_name="skills")## serializersfromrest_frameworkimportserializersclassSkillSerializer(serializers.ModelSerializer):classMeta:model=Skillfields=('id','user','name')classUserSerializer(serializers.ModelSerializer):skills=SkillSerializer(many=True,read_only=True)classMeta:model=Userfields=('id','url','username','email','is_staff','skills')## viewsetsfromrest_frameworkimportviewsetsfromdjango_returnfieldsimportserializer_factoryclassUserViewSet(viewsets.ModelViewSet):queryset=User.objects.all()serializer_class=serializer_factory(UserSerializer)classSkillViewSet(viewsets.ModelViewSet):queryset=Skill.objects.all()serializer_class=serializer_factory(SkillSerializer)## routesrouter=routers.DefaultRouter()router.register(r'users',viewsets.UserViewSet)router.register(r'skills',viewsets.SkillViewSet)urlpatterns=[url(r'^api/',include(router.urls)),]

0.3.2

  • 简化
  • 错误修复,优化不使用序列化程序has many=False选项

0.3.1

  • django restframework字段的支持源选项

0.3

  • 重写积极的实现

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java Android首选项相同getPreference()值的不同数据   字符串如何在Java中连接两个列表中的单词   安卓 Java Socket编程:检测客户端和服务器是否连接   使用JTextField的java无法将值转换为int   在java中,如何在不通过超级构造函数设置的情况下将消息设置为自定义异常类   用于标识属性值的java正则表达式模式   Android中的java不可见谷歌地图   java正确取消启动ExecutorService的JavaFX任务   在非活动java类中使用安卓的融合位置提供程序,并在主活动类中获取经度和纬度   spring为什么我的大摇大摆不能用springboot在java中工作?   java JSF(2.2)ViewScope在Weblogic 12.2.1.2和JDK 8上使用Spring 4.3.7(在Mac OS和Docker Oracle Linux环境上)   java如何用一个按钮提高计时器速度   java如何检查字符是否是元音?   注册表引用了不存在的Java运行时环境安装或运行时已损坏错误   来自ResultSet java的mysql getDateTime   maven LanguageTool Java API是否具有“无用”依赖关系?   twitter api身份验证的java Trycatch问题   java在Apache Struts 1.1中是否可以显式白名单?   安卓致命异常:主java。lang.RuntimeException:被问及未知片段