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

Question

是否有任何lib / parser可以从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文档，实现此目的的方法请参考下面的链接。最后得到一个网站：

您可以使用markdown语法（需要markdown lib）来训练视图集，如：

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

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

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