Welcome to VNG-API-common’s documentation!

VNG-API-common implements generic tooling to implement and document RESTful APIs in a Common Ground information architecture.

This package/tooling is used in the reference implementations in the ZGW-API project, the reference lists and the Gemeentelijke Selectielijst.

VNG-API-common is a third party library for Django projects. It is based on Django Rest Framework and drf-yasg for schema generation.

Features

• Custom field inspectors to generate the correct schema in the API spec

• Output to OAS 2 and OAS 3 format

• Custom model fields to encourage DRY

• Common validators for input validation

• Tooling for end-product unit-tests (mocks, custom clients)

• Optional support for notifications

Contents:

• Quickstart
  • Installation
  • Usage
• Setup configuration
  • Loading JWTSecrets from a YAML file
  • Loading Applicaties from a YAML file
• Documentation helpers
  • Generating UML diagrams for Django models
• Modules reference
  • Model fields
  • Validators
  • Notities (Notes)
  • Filtering in the API
  • Permissions and authorization
  • Exceptions
  • API middleware
  • Viewset mixins
  • Serializers and serializer fields
  • HTTP Caching
  • Database helpers
  • Handling geographical data
  • Polymorphism
  • Obtaining a client
  • OpenAPI Specification handling
  • Common utility functions
  • Testing utilities
  • Exception handlers
• Change history
  • 2.11.0 (2026-02-10)
  • 2.10.7 (2026-01-15)
  • 2.10.6 (2026-01-08)
  • 2.10.5 (2025-11-14)
  • 2.10.4 (2025-10-21)
  • 2.10.3 (2025-10-16)
  • 2.10.2 (2025-10-13)
  • 2.10.1 (2025-10-03)
  • 2.10.0 (2025-09-24)
  • 2.9.0 (2025-08-21)
  • 2.8.0 (2025-07-18)
  • 2.7.0 (2025-07-10)
  • 2.6.7 (2025-06-30)
  • 2.6.6 (2025-06-04)
  • 2.6.5 (2025-05-27)
  • 2.6.4 (2025-05-16)
  • 2.6.3 (2025-05-12)
  • 2.6.2 (2025-04-16)
  • 2.6.1 (2025-04-14)
  • 2.6.0 (2025-04-07)
  • 2.5.5 (2025-03-21)
  • 2.5.4 (2025-03-20)
  • 2.5.3 (2025-03-18)
  • 2.5.2 (2025-03-06)
  • 2.5.1 (2025-02-10)
  • 2.5.0 (2025-02-06)
  • 2.4.1 (2025-01-14)
  • 2.4.0 (2025-01-13)
  • 2.3.0 (2025-01-09)
  • 2.2.0 (2024-12-10)
  • 2.1.2 (2024-11-29)
  • 2.1.1 (2024-11-29)
  • 2.1.0 (2024-11-29)
  • 2.0.1 (2024-11-22)
  • 2.0.0 (2024-11-22)
  • 1.13.4 (2024-10-25)
  • 1.13.3 (2024-09-05)
  • 1.13.2 (2024-07-05)
  • 1.13.1 (2024-05-28)
  • 1.13.0 (2024-03-01)

Indices and tables

• Index

• Module Index

• Search Page