托多
nlx-middleware的Python项目详细描述
1 Welcome to nlx_middleware’s documentation!
Version: | 0.1.0 |
---|---|
Source: | https://github.com/maykinmedia/nlx_middleware |
Keywords: | ^{tt1}$ |
PythonVersion: | 3.6 |
一个django中间件,用于将您的服务与NLx集成。
如果 你在NLX网络中操作。这样就可以使用 NLX在任何地方都向外显示URL,同时仍然根据它们的 规范URL。
2 Features
- 将请求正文中的nlx outway url重写为规范url
- 将响应正文中的规范URL重写为NLX Outay URL
- 重写get query params中的url
- 利用openapi模式找出需要重写的内容
2.1 TODO:
- 设置要重写的外部服务注册表
- 支持OAS 3.0(通过gemma-zds-client)
3 Installation
3.1 Requirements
- Python 3.6或更高版本
- setuptools 30.3.0或更高版本
- django 1.11或以上
- django rest框架
- api架构必须在^{tt3}上可用$ (目前支持Swagger 2.0)
- gemma-zds-common(推荐)
3.2 Install
pip install nlx-middleware
4 Usage
向您添加中间件MIDDLEWARE设置:
MIDDLEWARE=['django.middleware.security.SecurityMiddleware',...'nlx_middleware.middleware.NLxInwayURLRewriteMiddleware',]
我们建议把它放在尽可能接近尾声的地方。回顾Django 中间件文档以了解订单的重要性。
可选,但建议将nlx_middleware添加到INSTALLED_APPS。 这使得模型可用,您可以将外部服务映射到 规范的域/地址,以便您自己不提供/服务的URL 项目也可以重写。
如果您不需要这个,那么(当前)不需要将它添加到 INSTALLED_APPS。
接下来,确保定义了以下设置:
NLX_SERVICE=os.getenv('NLX_SERVICE','zrc')NLX_INWAY_ADDRESS=os.getenv('NLX_ADDRESS','localhost:8000')NLX_ORGANIZATION=os.getenv('NLX_ORGANIZATION','vng-realisatie')NLX_OUTWAY_ADDRESS=os.getenv('NLX_OUTWAY_ADDRESS','http://localhost:2018')
注意
在这个例子中,我们从环境中提取它们,但是您当然可以 遵循你自己喜欢的方法。