zgw-consumers-oas 1.0.0

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.

1 ZGW Consumers’ OAS tooling

Version:

1.0.0

Source:

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

Keywords:

OpenAPI, Django, zgw-consumers

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.

Contents

• 1 ZGW Consumers’ OAS tooling

• 2 Installation

  • 2.1 Requirements

  • 2.2 Install

• 3 Usage

ZGW Consumers used to have a hard requirement on OpenAPI 3.0 specifications for its services. On the way to 1.0, this requirement became obsolete, and it has no need anymore for this kind of tooling.

However, we understand that upgrading to zgw-consumers 1.0 is quite a big breaking change if you rely on this tooling, so it was decided to provide it in a standalone package to ease the transition.

This package is considered “feature complete” and will only receive bugfixes. No new features will be added.

2 Installation

2.1 Requirements

• Python 3.10 or newer

• Django 3.2 or newer

2.2 Install

1. Install from PyPI

pip install zgw-consumers-oas

3 Usage

1. Update the relevant zgw_consumers.test.* imports to zgw_consumers_oas.*

2. You can continue using the ZGW_CONSUMERS_* settings to discover OpenAPI schema files.