一个django应用程序,用tastype生成一个简单而自动的api文档
django-tastypie-simple-api-doc的Python项目详细描述
一个Django应用程序,用tastype生成一个简单而自动的api文档
安装
pip install django-tastypie-simple-api-doc
用法
首先,将其添加到已安装的app和django_标记(我们使用此包格式化类docstring)。
INSTALLED_APPS = ( 'tastypie_api_doc', 'django_markup', )
然后你需要告诉我你的Tastypie Api对象将被记录在哪里把它的路径放在settings.py中,如下所示:
API_OBJECT_LOCATION = "app.module.object_name"
在我的测试项目中是这样的:
API_OBJECT_LOCATION = "project.urls.v1_api"
明白了吗?现在转到URL模块,如下所示:
from tastypie_api_doc.views import build_doc urlpatterns = [ ... url(r'^choose_your_url', build_doc), ]
我们就快到了现在,如果你知道我的意思,你需要“收集你的静电”:p
python manage.py collectstatic
就这样:)
这是一个正在进行的工作,但它可以在您的项目中使用所以,请继续关注。请随意贡献,让这个应用程序更好的方式=天