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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for commonground-api-common-1.12.2.tar.gz
Algorithm Hash digest
SHA256 cb613164f5ca6520f07b538ec2aa6f3f51600bb83dc55ce703f53c72f9386d39
MD5 8bdd4c7360447edf2b26ec17c54cf825
BLAKE2b-256 255c3bded07fb255c86960e3bdeaae6314f055dad6fe1be0b3c30dfab74b397b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commonground_api_common-1.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a40f70c2cd3131680dd2f0d30650461a1ddb9f19a5ac89c999914dab7955f205
MD5 f89254ddb56dcf1004569612970779a6
BLAKE2b-256 3194382712289d8fdeb6d4ef62258f0cb38607bb5e1bbfe5d28543d0a614834d

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