okapi 0.12.0

需求/base.txt

将以下要求添加到项目的设置中。不需要 如果项目已经在使用它，则添加requests。 requests版本应为>；=2.2.11:

okapi==X.Y.Z

设置.py

将以下配置添加到项目设置中：

########## OKAPI CONFIGURATIONOKAPI_PROJECT='your-project-name'OKAPI_URI=Noneifsettings.has_section('okapi'):OKAPI_URI='mongodb://{0},{1},{2}/{3}?replicaSet={4}'.format(settings.get('okapi','host0'),settings.get('okapi','host1'),settings.get('okapi','host2'),settings.get('okapi','name'),settings.get('okapi','replica'),)########## END OKAPI CONFIGURATION

注意，如果项目已经在使用mongodb，则不应该存储okapi 将数据放入同一数据库。Okapi动态创建集合，并可以 与您的项目冲突。

初始化

在项目的基本应用程序的models.py文件中初始化okapi。 这样okapi将在启动时导入：

importrequestsfromdjango.confimportsettingsfromokapi.apiimportApiproject_name=getattr(settings,'OKAPI_PROJECT')mongodb_uri=getattr(settings,'MONGODB_URI')okapi_client=Api(project_name,requests,mongodb_uri)

使用量

一旦初始化，就可以在任何使用requests库的地方使用okapi。 把okapi想象成使用requests，因为它们都有相同的 应用程序编程接口。

请求文档：http://docs.python-requests.org/en/latest/

在项目中激活/停用okapi

在文件settings/base.py的OKAPI CONFIGURATION部分中，您 可以添加布尔设置以启用/禁用项目的okapi。它 在qa或staging环境中以及之后启用它可能会很有趣 它已经过适当的测试，并在生产中激活。

您可以将节放入your-project-name/settings/dev.py：

########## OKAPI CONFIGURATIONOKAPI_ENABLED=True########## END OKAPI CONFIGURATION

另一个放入your-project-name/settings/production.py：

########## OKAPI CONFIGURATIONOKAPI_ENABLED=False########## END OKAPI CONFIGURATION

等等。注意get_custom_setting是getattr的包装。 然后可以按如下所示有条件地初始化它：

http_lib=requestsif(get_custom_setting('OKAPI_ENABLED')andokapi_uriisnotNone):project_name=get_custom_setting('OKAPI_PROJECT',required=True)okapi_uri=get_custom_setting('OKAPI_URI',required=True)okapi_client=Api(project_name,requests,okapi_uri)http_lib=okapi_client