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

【问题标题】：Generating an API blueprint documentation from Django/DRF code从 Django/DRF 代码生成 API 蓝图文档
【发布时间】：2018-03-08 17:33:01
【问题描述】：

是否有任何 lib/parser 可以从 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)
    + ...
    """

【问题讨论】：

标签： django django-rest-framework apiblueprint apiary.io

【解决方案1】：

我使用 DRF 内置 API 文档，实现方法请参考下面的链接。最后得到一个类似的网站：

您可以使用 markdown 语法（需要 markdown 库）来记录视图集，例如：

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

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

【讨论】：

感谢您的回复，但我正在与不同类型的开发人员合作，我们只使用蓝图 api。
您好！我正在尝试像这样记录我的 API。我在描述字段中苦苦挣扎。如何向其中添加文本？还有自定义模板/模式的方法吗？

【解决方案2】：

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

【讨论】：

我想，只有降价语法的文件。也许是时候开始这样的开源项目了:-)

【解决方案3】：

你可以试试swagger

【讨论】：