Django Rest Framework custom schema for view in viewset

Question

I have an API built using Django and Django REST Framework. I have a model that returns some JSON that is built that doesn't correspond to a typical Django model. So the auto-documentation feature that seems to utilize knowledge about Django models doesn't work for some of my views.

In particular, I have a viewset that returns some typical API views (like a list of objects), and some views that return some of my custom objects. I'd like to build documentation for these custom objects, but I am not sure how to override the schema for a particular endpoint within a viewset. How can I override the schema generated for a single view in a DRF viewset?

DRF seems to provide this functionality for views, but I want to do the same for Viewsets.

I didn't. I just ended up building out custom documentation on my own. — Alex Alifimoff
– Alex Alifimoff, Commented Jul 16, 2018 at 22:22
Ah, thanks. Custom documentation as in completely separate documentation or just this part using coreapi/schema in DRF? — TheKalpit
– TheKalpit, Commented Jul 18, 2018 at 8:45

pawel.ad · Accepted Answer · 2018-09-13 22:51:42Z

7

OK, after a lot of try-fail-retry, I finally got it to work - you lose some of the auto(magical) introspection, like the id path parameter and the description taken from the docstring, but I still thing it's worth it:

custom_schema = ManualSchema(
    fields=[
        coreapi.Field(
            "id",
            required=True,
            location="path",
            schema=coreschema.String(
                title="ID",
                description="Foobar ID.",
            )
        ),
        coreapi.Field(
            "foobar",
            location="query",
            schema=coreschema.String(
                title="Foobar",
                description="Foobar?",
            )
        ),
    ],
    description="Foobar!",
)


class FoobarViewSet(viewsets.ReadOnlyModelViewSet):

    @action(methods=["get"], detail=True, schema=custom_schema)
    def foobar(self, request, id=None):
        ...

answered Sep 13, 2018 at 22:51

pawel.ad

6911 gold badge7 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

radtek Over a year ago

How do you do this for built in views like list, get, etc.. ?

pawel.ad Over a year ago

You can re-define them, decorate them, and return exactly what they would with super()

radtek Over a year ago

Thats the thing, you cant decorate them with action ... seems to be limiting. Do you have an example to share?

pawel.ad Over a year ago

Oh, I see your point. No sorry, I don't have any other ideas right now.

Collectives™ on Stack Overflow

Django Rest Framework custom schema for view in viewset

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related