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.19.1.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

zds_schema-0.19.1-py2.py3-none-any.whl (53.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: zds-schema-0.19.1.tar.gz
  • Upload date:
  • Size: 35.9 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.6

File hashes

Hashes for zds-schema-0.19.1.tar.gz
Algorithm Hash digest
SHA256 6580d2d221c260e7b410852d70748e40e89362f13e72a6a2bbd2bcd5dea0e1d2
MD5 a97c7585bc191fb19f16d46622fecd6f
BLAKE2b-256 c12f07f9a570e7fc92088328a4dcb7ea6f3f5a2454ff9f51a455ccb7dcf674f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zds_schema-0.19.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 53.6 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.6

File hashes

Hashes for zds_schema-0.19.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ad33dc6bc9d1c1baff80ae20ebf6c4a8087303a788b7f33ca449ce9423c773e
MD5 0b456a9a7c68ce76f4a58c0cf2d9cf19
BLAKE2b-256 1989aea2ae934cf5697e5a338b8922953a636e20db0c169f07cd5aadc2d94e2b

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