从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)
    + ...
    """

- User

Answer 1

我使用DRF内置的API文档，实现此方法请参考下方链接。最终获得一个类似于以下网站的页面： 您可以使用Markdown语法（需要Markdown库）来记录视图集，例如：

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 API文档

顺便提一下，现在内置文档的表格描述是从序列化字段的help_text中获取的，我将其改为label，如果您也想更改，请告诉我，我会再次发布相关代码。

- Ykh

---

谢谢您的回复，但我正在与不同类型的开发人员合作，我们只使用蓝图API。 - User

嗨！我正在尝试像这样记录我的 API。我遇到了描述字段的问题。我该如何添加文本？还有一种自定义模板/架构的方法吗？ - Micromegas

Answer 2

使用Django Rest Framework代码生成API蓝图文档，您需要使用类似于Markdown的简单语法来描述API。这意味着您可以使用例如Blueprint和aglio软件包。否则，还有许多出色的第三方文档工具可供选择。

- Junior Gantin

---

正如我所想，只有采用 Markdown 语法的文件。也许是时候开始这样一种开源项目了 :-) - User

Answer 3

你可以尝试使用 swagger

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

- andilabs