django - 从 Django/DRF 代码生成 API 蓝图文档

Question

是否有任何可以从 Django + Django Rest Framework 代码生成 API 蓝图文档(apiary)的库/解析器？例如:

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


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

Answer 1

我使用 DRF 内置 API 文档，实现方法请引用下面的链接。最后得到一个像这样的网站:

您可以使用 Markdown 语法(需要 Markdown 库)来记录 View 集，例如:

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

文档 list_route喜欢 :

@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

顺便说一句，现在内置文档的表描述是获取表单序列化字段的帮助文本，我将其更改为标签，如果您也想更改它，请告诉我，我将再次发布与它相关的代码。