Generating an API blueprint documentation from Django/DRF code

Question

Is there any lib/parser which can generate API blueprint documentation (apiary) from Django + Django Rest Framework code? Eg:

class UserView(...):
    """
    ## Users list [GET /users]
    + Request (application/json)
        ...
    + Response (application/json)
        ...
    """


class UserSerializer(...):
    """
    ## User (object)
    + id (string)
    + username (string)
    + ...
    """

Answer 1

I use DRF Built-in API documentation,the way to achieve this please refer to the link below.and finally get a website like:

You can use markdown syntax(markdown lib is need) to doc viewset like:

class UserViewSet(ModelViewSet):
    """
    create: add user.
    list: list user
    retrieve: retrieve user
    """

doc list_route like :

@list_route(methods=['POST'], permission_classes=[AllowAny], serializer_class=None)
def login(self, request):
    """
     login
     <p>【Receive】tel: tel password: password keep_login: Token change
     <p>【Return】200 success 400 failed
    """

DRF Documenting your API

By the way,now build-in docs's table Description is get form serializer fields's help_text,I change it to label,if you want change it too,tell me and i will post the code related to it again.

Answer 2

For generating an API blueprint documentation with Django Rest Framework code, you need to you describe your API using a simple markdown-like syntax. That means that you use Blueprint and aglio package for example. Otherwise, there are also a number of great third-party documentation tools available.

Answer 3

You can give a try to swagger

for more info see here: http://www.django-rest-framework.org/topics/documenting-your-api/#third-party-packages