ZGW Consumers

ZGW Consumers allows you to manage your external services through the Django admin.

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

Developed for use in Dutch government software where data exchange with external services is run of the mill, this library provides flexibility in configuring your environment(s).

ZGW Consumers allows you to centralize the location, credentials, API schema information… to connect to HTTP-based services. There is first class support for OpenAPI 3 specifications, but you are not limited to “modern” RESTful services! SOAP/XML services can still leverage the utilities offered by ZGW Consumers.

Contents:

• Quickstart
  • Installation
  • Usage
• Settings
• Recipes
  • Handling pagination in API endpoints
• Models
  • Concrete
  • Abstract
• Model fields
  • ServiceUrlField
• Django Rest Framework
  • Serializers
  • Serializer fields
• Testing utilities
  • Using factories
  • Other utilities
• API reference
  • client
  • nlx
  • utils
• Changes
  • 0.33.0 (2024-03-29)
  • 0.32.0 (2024-03-26)
  • 0.31.0 (2024-03-15)
  • 0.30.0 (2024-02-22)
  • 0.29.0 (2024-02-05)
  • 0.28.0 (2024-01-11)
  • 0.27.0 (2023-10-10)
  • 0.26.2 (2023-05-25)
  • 0.26.1 (2023-04-06)
  • 0.26.0 (2023-04-04)
  • 0.25.0 (2023-02-27)
  • 0.24.0 (2023-02-16)
  • 0.23.2 (2022-12-06)
  • 0.23.1 (2022-11-16)
  • 0.23.0 (2022-11-15)
  • 0.22.0 (2022-10-28)
  • 0.21.2 (2022-09-07)
  • 0.21.1 (2022-09-07)
  • 0.21.0 (2022-08-31)
  • 0.20.0 (2022-08-22)
  • 0.19.0 (2022-07-22)
  • 0.18.2 (2022-06-13)
  • 0.18.1 (2022-05-17)

Indices and tables

• Index

• Module Index

• Search Page