Configuration for service (OpenAPI 3 or other) consumers
Project description
1 Welcome to ZGW Consumers’ documentation!
- Version:
0.31.0
- Source:
- Keywords:
OpenAPI, Zaakgericht Werken, Common Ground, NLX
Manage your external API’s to consume.
2 Features
Store services with their configuration in the database
Integrate with OpenAPI 3.0 specifications
NLX support
Declare data/domain objects as modern Python dataclasses
3 Installation
3.1 Requirements
Python 3.10 or newer
Django 3.2 or newer
3.2 Install
Install from PyPI
pip install zgw-consumers
Add zgw_consumers and simple_certmanager to the INSTALLED_APPS setting.
Optionally override ZGW_CONSUMERS_CLIENT_CLASS to a custom client class.
Optionally specify ZGW_CONSUMERS_OAS_CACHE to point to a separate django cache. Defaults to django.core.cache.DEFAULT_CACHE_ALIAS, which is default in practice. For performance reasons we highly recommend to use a real cache backend like Redis or Memcache.
4 Usage
In the Django admin, you can create Service instances to define your external APIs.
Client
To get a client for a given resource, you can use:
from zgw_consumers.client import build_client
from zgw_consumers.models import Service
my_service = Service.objects.get(api_root="https://api.example.com/")
client = build_client(my_service)
with client:
# The preferred way to use the client is within a context manager
client.get("relative/url")
The resulting client will have certificate and authentication automatically configured from the database configuration.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for zgw_consumers-0.31.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd2965180931de92f7e2c80dcfed279a0fbf5d6e521d71b1278061e01eecc1f8 |
|
MD5 | 52fa85e5a8d4657d4ed1d8df374f5d52 |
|
BLAKE2b-256 | 26e02378863e856d630fa7f408ae4f3764262a939807de6871fb6b6bdae8185b |