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

Uploaded Source

Built Distribution

zds_schema-0.21.3-py2.py3-none-any.whl (56.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: zds-schema-0.21.3.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.21.3.tar.gz
Algorithm Hash digest
SHA256 638666597251606c1444cacde8ae4529f916f8369b7be86c85a2e21a7000209b
MD5 96327c40f921e4bb7bd094b420d9e382
BLAKE2b-256 5051479a3e67cb30e0c4494a33a1150058463efef2ca9823e94ff4c56763096f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zds_schema-0.21.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 56.0 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.21.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e4fe85cca14cc76b3cc15d1b7ba5882b66ae58e0caa9ffe212a228393b14661
MD5 63e647f605db274288bd72bde447e354
BLAKE2b-256 86922d4cdfa8fc2ada4c15e7936002ca9d9f2973aa85939a8f0c61bd7ec43ba1

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