Skip to main content

Schema-generatie tooling

Project description

ZDS-Schema voorziet een generieke API schema-generatiestrategie die gedeeld wordt tussen verschillende componenten betrokken in zaakgericht werken.

1 Features

  • Centraal beheer van cosntanten 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

2 Installatie

2.1 Benodigdheden

  • Python 3.6 of hoger

  • setuptools 30.3.0 of higher

2.2 Installeren

pip install zds_schema

3 Gebruik

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

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

zds-schema-0.22.0.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

zds_schema-0.22.0-py2.py3-none-any.whl (56.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file zds-schema-0.22.0.tar.gz.

File metadata

  • Download URL: zds-schema-0.22.0.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.8

File hashes

Hashes for zds-schema-0.22.0.tar.gz
Algorithm Hash digest
SHA256 6cc6703a7b50a24eb02c74def296dbdd034bf574d17485c080f57e93b987b6a9
MD5 b22cd6440b118ac9eeaa0770fff39bc2
BLAKE2b-256 5602e320d4228b066b6015b3a2932f0c31602dc33be05566a8377973a729603c

See more details on using hashes here.

File details

Details for the file zds_schema-0.22.0-py2.py3-none-any.whl.

File metadata

  • Download URL: zds_schema-0.22.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 56.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.8

File hashes

Hashes for zds_schema-0.22.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ec3a8bc765b0f4d2364cadd1bfde5d2bc15614abc135eddcdff5321b4f881276
MD5 e951bc24da74f8fb7bae4a33e4e59aae
BLAKE2b-256 9c5ed402f0376e64c93b712c73659dec3d458bd335a2d62aec696597518d25e6

See more details on using hashes here.

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