VNG API tooling
Project description
VNG-API-common biedt generieke implementaties en tooling voor RESTful APIs in een Common Ground gegevenslandschap.
De tooling wordt o.a. gebruikt in de referentie-implementaties van componenten voor zaakgericht werken, maar ook in VNG-APIs voor referentielijsten en de Gemeentelijke Selectielijst.
Zie de uitgebreide documentatie voor de features en het gebruik.
Contents
1 Features
- Centraal beheer van constanten die de verschillende componenten overstijgen
- GeoJSON OpenAPI definities
- Support voor Geo CRS negotation
- Ingebouwde support voor nested viewsets met declaratievere syntax voor registratie
- Vaak voorkomende validators:
- RSIN/BSN validator
- Numerieke waarde validator
- Niet-negatieve waarde validator
- Alfanumerieke waarde (zonder diacritics)
- URL-validator (test dat URL bestaat) met pluggable link-checker
- UntilNowValidator - valideer datetimes tot en met nu.
- UniekeIdentificatieValidator (in combinatie met organisatie)
- InformatieObjectUniqueValidator om te valideren dat M2M entries slechts eenmalig voorkomen
- ObjectInformatieObjectValidator om te valideren dat de synchronisatie van een object-informatieobject relatie pas kan nadat deze relatie in het DRC gemaakt is
- IsImmutableValidator - valideer dat bepaalde velden niet gewijzigd worden bij een (partial) update, maar wel mogen gezet worden bij een create
- ResourceValidator - valideer dat een URL een bepaalde resource ontsluit
- Custom inspectors voor drf-yasg:
- Support voor rest_framework_gis GeometryField
- SUpport voor django-extra-fields Base64FieldMixin
- URL-based related resource filtering (django-filter support)
- verzameling van mogelijke error-responses per operation
- Management command generate_swagger overloaded
- neemt default versie mee en maakt server-informatie domein-agnostisch
- optie om informatiemodel-resources naar markdown te renderen met backlinks naar gemmaonline.nl
- Support voor ISO 8601 durations
- Custom model fields:
- RSINField
- BSNField
- LanguageField
- VertrouwelijkheidsAanduidingField
- DaysDurationField
- Mocks voor de validators die netwerk IO hebben, eenvoudig via @override_settings toe te passen
- Test utilities
- Optionele notificaties applicatie:
- ontvangen van webhook events
- configureren en registreren van notificatiecomponent/webhooks
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for vng-api-common-utrecht-1.3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62467583b5b86b85f41ad1b1690e80a750a727ac76691c0d577528a80ce4028f |
|
MD5 | 0cc52553941f7f7914390e2fa2c4de5c |
|
BLAKE2-256 | e6cd7e8023ef8f346e66497a7969365bfc47d0af5363e10ceb76a126fd0b67f0 |
Close
Hashes for vng_api_common_utrecht-1.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08a22b78577b526224af3a9cdef5b6da13fd9d7f4db14a9deacad4b7ce235200 |
|
MD5 | e4a95a5de0a4b81993c4c77ebbc0118a |
|
BLAKE2-256 | 8bce478a9c438eb223536d566d984164651444c97ded62d177bf3f2032e66280 |