zgw-consumers 0.38.1

Configuration for service (OpenAPI 3 or other) consumers

1 Welcome to ZGW Consumers’ documentation!

Version:

0.38.1

Source:

https://github.com/maykinmedia/zgw-consumers

Keywords:

OpenAPI, Zaakgericht Werken, Common Ground, NLX

Manage your external API’s to consume.

Contents

• 1 Welcome to ZGW Consumers’ documentation!

• 2 Features

• 3 Installation

  • 3.1 Requirements

  • 3.2 Install

• 4 Usage

2 Features

• Store services with their configuration in the database

• Built in ape-pie API client adapter

• NLX support

• Declare data/domain objects as modern Python dataclasses

3 Installation

3.1 Requirements

• Python 3.10 or newer

• Django 4.2 or newer

3.2 Install

1. Install from PyPI

pip install zgw-consumers

2. Add zgw_consumers and simple_certmanager to the INSTALLED_APPS setting.

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.