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.
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
- Modules reference