django小说的restful json api概述。更广泛的MacOutliner项目的一部分。
django-fiction-outlines-api的Python项目详细描述
django小说的restful json api概述。
文档
完整的文档位于https://django-fiction-outlines-api.readthedocs.io。源代码可以在https://github.com/maceoutliner/django-fiction-outlines-api/找到。
快速启动
安装django小说大纲api:
pip install django-fiction-outlines-api
将它和依赖项添加到已安装的应用程序中
INSTALLED_APPS=(...''rest_framework','taggit','rules.apps.AutodiscoverRulesConfig','rest_framework_rules','fiction_outlines','fiction_outlines_api',...)
如果还没有,请添加rules到您的AUTHENTICATION_BACKENDS。
AUTHENTICATION_BACKENDS=('rules.permissions.ObjectPermissionBackend','django.contrib.auth.backends.ModelBackend',)
除非您喜欢危险地生活,否则建议您将用于大纲的数据库配置为从ATOMIC_REQUESTS到True。
DATABASES={"default":{"ENGINE":"django.db.backends.postgresql","NAME":"outlines","ATOMIC_REQUESTS":True,}}
add django fiction概述了api的url模式:
fromfiction_outlines_apiimporturlsasfiction_outlines_api_urlsurlpatterns=[...url(r'^',include(fiction_outlines_api_urls)),...]
如果尚未安装fiction_outlines,则应立即运行python manage.py migrate。
功能
- 使用Django REST Framework为django-fiction-outlines提供restful api,适用于json、xml或可浏览的html序列化。
注意:与fiction_outlines一样,此应用程序使用优秀的对象权限库django-rules。
运行测试
代码真的有用吗?
source <YOURVIRTUALENV>/bin/activate (myenv) $ pip install -r test_requirements.txt (myenv) $ pytest (myenv) $ flake8 setup.py fiction_outlines_api tests
历史记录
0.2.1(2018-10-16)
- 同时支持Python3.6和3.7
0.2.0(2018-08-08)
- 支持Django 2.1
0.1.3(2018-06-21)
- 将依赖项移回正式的django taggit序列化程序包,因为我们的pull请求已经合并。
0.1.0(2018-04-07)
- pypi上的第一个版本。