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

Question

有没有库/解析器可以从Django + Django Rest Framework代码中生成API蓝图文档？例如：

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


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

Answer 1

我使用的是DRF内置的API文档，实现这个的方法请参考below.and的链接，最后得到一个类似的网站：

​

您可以使用markdown语法(需要markdown lib )来doc视图集，如下所示：

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

doc 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

顺便说一下，现在内置文档的表描述是get form serializer字段的help_text，我将其更改为label，如果您也想更改它，请告诉我，我将再次发布相关代码。

Answer 2

为了使用Django Rest Framework代码生成API蓝图文档，您需要使用简单的markdown语法来描述您的API。例如，这意味着您使用Blueprint和aglio包。除此之外，还有许多优秀的third-party文档工具可用。

Answer 3

你可以试一试swagger

欲了解更多信息，请访问此处：http://www.django-rest-framework.org/topics/documenting-your-api/#third-party-packages