Skip to main content

Commonground API tooling

Project description

Build status Code quality checks Coverage status Documentation Status black

python-versions django-versions pypi-version

Commonground-API-common biedt generieke implementaties en tooling voor RESTful APIs in een Common Ground gegevenslandschap.

Dit project is een fork van commonground-api-common.

Zie de uitgebreide documentatie voor de features en het gebruik.

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


Download files

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

Source Distribution

commonground-api-common-1.12.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

commonground_api_common-1.12.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file commonground-api-common-1.12.0.tar.gz.

File metadata

File hashes

Hashes for commonground-api-common-1.12.0.tar.gz
Algorithm Hash digest
SHA256 4a2abfa5b10cc1a8f3ea941b1e3e2bae9607c7bc8b09355256ab21c9f0ea8d1e
MD5 5cc1d846d86d4547eacde38950195b55
BLAKE2b-256 e3d7662cb7d50e20b88f322864f29290299951b510a34d5fb822de89811cfa15

See more details on using hashes here.

File details

Details for the file commonground_api_common-1.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for commonground_api_common-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcc4c40c87466a5272e28ab2bfcacf5eb00101d8f77eea803c0d40851f42ea5e
MD5 39b7975b0587ad4c21f013d7c98de39e
BLAKE2b-256 717237f9a72b78d7c68371312f9f9b606470aebc021c14557f16c3c2bc1f405e

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