VNG API tooling

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for joeribekker from gravatar.com joeribekker Avatar for maykinmedia from gravatar.com maykinmedia Avatar for sergei.maertens from gravatar.com sergei.maertens Avatar for stevenbal1 from gravatar.com stevenbal1 Avatar for vngr from gravatar.com vngr

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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.

Het is een third-party library voor Django projecten, gebaseerd op Django Rest Framework en drf-yasg voor schema-generatie.

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

2 Installatie

2.1 Benodigdheden

  • Python 3.6 of hoger

  • setuptools 30.3.0 of higher

2.2 Installeren

pip install vng-api-common

Indien je de notifications app wil gebruiken, dan kan je extra dependencies installeren via:

pip install vng-api-common[notifications]

3 Gebruik

Zie de referentie-implementaties voor ZRC, DRC, BRC en ZTC.

3.1 Notifications

This library ships with support for notifications, in the form of view(set) mixins.

To enable them, add:

...,
'django.contrib.sites',
'vng_api_common.notifications',
...

to your INSTALLED_APPS setting.

Two additional settings are available:

  • NOTIFICATIONS_KANAAL: a string, the label of the ‘kanaal’ to register with the NC

  • NOTIFICATIONS_DISABLED: a boolean, default False. Set to True to completely disable the sending of notifications.

Next, in the admin interface, open the notifications configuration and enter the URL + credentials of the NC to use.

Make sure you also have the Sites set up correctly, as the domain configured there is used to build the documentation URL.

After entering the configuration, you can register your ‘kanaal’ - this action is idempotent:

python manage.py register_kanaal

Usage in code

Define at least one Kanaal instance, typically this would go in api/kanalen.py:

from vng_api_common.notifications.kanalen import Kanaal

from zrc.datamodel.models import Zaak

ZAKEN = Kanaal(
    'zaken',  # label of the channel/exchange
    main_resource=Zaak,  # main object for this channel/exchange
    kenmerken=(  # fields to include as 'kenmerken'
        'bronorganisatie',
        'zaaktype',
        'vertrouwelijkheidaanduiding'
    )
)

To send notifications, add the mixins to the viewsets:

  • vng_api_common.notifications.viewsets.NotificationCreateMixin: send notifications for newly created objects

  • vng_api_common.notifications.viewsets.NotificationUpdateMixin: send notifications for (partial) upates to objects

  • vng_api_common.notifications.viewsets.NotificationDestroyMixin: send notifications for destroyed objects

  • vng_api_common.notifications.viewsets.NotificationViewSetMixin: a combination of all three mixins above

and define the attribute notifications_kanaal on the viewset:

from .kanalen import ZAKEN


class ZaakViewSet(NotificationViewSetMixin, viewsets.ModelViewSet):
    ...
    notifications_kanaal = ZAKEN

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for joeribekker from gravatar.com joeribekker Avatar for maykinmedia from gravatar.com maykinmedia Avatar for sergei.maertens from gravatar.com sergei.maertens Avatar for stevenbal1 from gravatar.com stevenbal1 Avatar for vngr from gravatar.com vngr

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.0

1.8.0

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.10

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.0

1.1.0

1.0.69

1.0.68

1.0.67

1.0.66

1.0.65

1.0.64

1.0.63

1.0.62

1.0.61

1.0.60

1.0.59

1.0.58

1.0.57

1.0.56

1.0.55

1.0.54

1.0.53

1.0.52

1.0.51

1.0.50

1.0.49

1.0.48

1.0.47

1.0.46

1.0.45 yanked

Reason this release was yanked:

Bug not fixed

1.0.44

1.0.43

1.0.42

1.0.41

1.0.40

1.0.39

1.0.38

1.0.37

1.0.36

1.0.35

1.0.34

1.0.33

1.0.32

1.0.31

1.0.30

1.0.29

1.0.28

1.0.27

1.0.26

1.0.25

1.0.24

1.0.23

1.0.22

1.0.21

1.0.20

1.0.19

1.0.18

1.0.17

1.0.16

1.0.15

1.0.14

1.0.13

1.0.12

1.0.11

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.3

1.0.2

1.0.1

1.0.0

0.59.3

0.59.2

0.59.1

0.59.0

0.58.1

0.58.0

0.57.3

0.57.2

0.57.1

0.57.0

0.56.1

0.56.0

0.55.1

0.55.0

0.54.0

0.53.0

0.52.6

0.52.5

0.52.4

0.52.3

0.52.2

0.52.1

0.52.0

0.51.2

0.51.1

0.51.0

0.50.4

0.50.3

0.50.2

0.50.1

0.50.0

0.49.3

0.49.2

0.49.1

0.49.0

0.48.1

0.48.0

0.47.2

0.47.1

0.47.0

0.46.2

0.46.1

0.46.0

0.45.0

0.44.0

0.43.3

0.43.2

0.43.1

0.43.0

0.42.1

0.42.0

0.41.2

0.41.1

0.41.0

0.40.1

0.40.0

0.39.1

0.39.0

0.38.2

0.38.1

0.38.0

0.37.4

0.37.3

0.37.2

0.37.1

0.37.0

This version

0.36.1

0.36.0

0.35.10

0.35.9

0.35.8

0.35.7

0.35.6

0.35.5

0.35.4

0.35.3

0.35.2

0.35.1

0.35.0

0.34.1

0.34.0

0.33.0

0.32.3

0.32.2

0.32.1

0.32.0

0.31.2

0.31.1

0.31.0

0.30.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vng-api-common-0.36.1.tar.gz (50.7 kB view hashes)

Uploaded Source

Built Distribution

vng_api_common-0.36.1-py2.py3-none-any.whl (73.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page