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.10.2.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

commonground_api_common-1.10.2-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for commonground-api-common-1.10.2.tar.gz
Algorithm Hash digest
SHA256 9e340c2b00338f6470e04341d071aeca101bea90c8adb3f7b6c06bcd0cdb1a2c
MD5 7af383e2cb5bfc272b4b1e5f94c88a7e
BLAKE2b-256 89e1893afb8d4e899a0734027fe6636f4101c1d6c758c527943c5951ac57cd8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commonground_api_common-1.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1a2908b2f2f870e3ec0f316f433a0c94c21263c0352e9f957bff8e8fe607b470
MD5 64f3bf9cc61d9e62c0e7fda2a990261c
BLAKE2b-256 80585b56b073a81fc4a84944bf36e93b65967a6ed7f86cd3680397a34bdfd597

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