我目前正在使用 django-rest-framework 构建一个 API。
示例(例如http://restframework.herokuapp.com/)具有对文档的 Markdown 支持。
如何在我自己的项目中激活它?它不是开箱即用的,我似乎无法在网站上找到这方面的帮助(在教程文档中)。我已经安装markdown
了 pip (v2.1.1)。
谢谢,
我目前正在使用 django-rest-framework 构建一个 API。
示例(例如http://restframework.herokuapp.com/)具有对文档的 Markdown 支持。
如何在我自己的项目中激活它?它不是开箱即用的,我似乎无法在网站上找到这方面的帮助(在教程文档中)。我已经安装markdown
了 pip (v2.1.1)。
谢谢,
您需要做的就是安装markdown
,然后编写降价格式的文档字符串。
如果它不起作用,您可能需要仔细检查您是否已将 markdown 安装到项目 virtualenv 中,而不是全局安装。
安装markdown
:
pip install markdown
Ctrl + c
通过按下正在运行的终端来停止 Django 服务器
再次启动 Django 服务器:python manage.py runserver
Django 会注意到 django 项目目录中文件的变化,但在安装新包时不会。因此,安装 markdown 后需要手动重启 Django。
嗯,感觉有点傻。
我的代码是:
class UserList(ListCreateAPIView):
"""
Display all `users`.
"""
工作代码应该是:
class UserList(ListCreateAPIView):
"""
Display all `users`.
"""
(markdown 字符串不应该缩进)