在带有 json api 的 django rest 框架中使用 slug 而不是 ID

Question

我的成员应用程序希望 JSON 响应包含模型 ID 的主键结果。我不想使用整数 ID，而是使用 slug。我知道在标准的 django 框架中你可以这样做：

from rest_framework import serializers
from .models import Page

class PageSerializer(serializers.ModelSerializer):
   id = serializers.CharField(source='slug')

   class Meta:
      model = Page
      fields = ('name','id',...etc )

但是，这在使用 json API 时不起作用 - 在我的回复中，我仍然有类似的东西

"data": [{
        "type": "pages",
        "id": "2",
        "attributes": {
            "name": "Some page name",                 
        }]

当我希望“id”字段类似于“some-page-name”（蛞蝓）时

这对于 json API 是不可能的。为清楚起见，上面等效的 json API 导入将是

 from rest_framework_json_api import serializers

非常感谢

****添加****

为了帮助澄清我面临的问题，这里是一个使用标准 REST 框架的序列化程序。下面显示的所有属性都包含在 Page 模型中。

from rest_framework import serializers
from .models import Page

class PageSerializer(serializers.ModelSerializer):
    id = serializers.CharField(source='slug')
    class Meta:
        model = Page
        fields = ('name','id')

我在 http://localhost:8000/api/pages 得到的 JSON 响应如下

 [
    {
      "name": "Page 1",
      "id": "page-1"
   },
   {
    "name": "Page 2",
    "id": "page-2"
   },
   {
     etc
   }
 ]

当我使用 json API 时，做的完全一样，但显然是导入

from rest_framework_json_api import serializers 

我无法以同样的方式更改 id 值，查看 http://localhost:8000/api/pages 时出现这样的情况

{
   "links": {
      omitted for brevity ...
   },
  "data": [
      {
        "type": "pages",
        "id": "1",
        "attributes": {
            "name": "Page 1"
        }
     },
     {
        "type": "pages",
        "id": "2",
        "attributes": {
            "name": "Page 2"
       }
    },
]

Answer 1

这是一种解决方案，它允许我查看例如 http://localhost:8000/api/pages 的响应，并以 Emberjs（期望响应符合 JSON API 规范）不会抱怨的格式向 http://localhost:8000/api/pages/some-slug 发出请求。

在我的序列化器（PageSerializer.py）中：

from rest_framework_json_api import serializers
from .models import Page

class PageSerializer(serializers.ModelSerializer):

    class Meta:
        model = Page
        fields = ('name','id','url','slug')
        lookup_field = 'slug'

        // if you want to show the links field in the response
        extra_kwargs = {'url': {'lookup_field':'slug'}}

在视图中（PageViewSet）

from rest_framework import viewsets
from .models import Page
from .serializers import PageSerializer

class PageViewSet(viewsets.ModelViewSet):

    queryset = Page.objects.all().order_by('name')
    serializer_class = PageSerializer
    lookup_field = 'slug'

路由器保持不变：

from django.urls import path, include
from rest_framework import routers
from page import views

router = routers.DefaultRouter(trailing_slash=False)
router.register('pages',views.PageViewSet)

urlpatterns = [
   path('api/',include(router.urls)),
]

Answer 2

我认为您想要的是使用您的 slug 字段而不是 id 作为您的主键，以便您可以在您的 url 中传递该参数以获得所需的结果。 您可以在您的网址中执行类似的操作

url(r'^something-here/(?P<slug>[\w-]+)/$', "your_view_name_here", name='name_you_want')

在您的观点中，您可以执行以下操作：

class YourListAPIView(ListAPIView):
    serializer_class = YourSerializer
    def get_queryset(self):
        slug = self.kwargs['slug']
        return ModelName.objects.filter(slug=slug)