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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for commonground-api-common-1.13.0.tar.gz
Algorithm Hash digest
SHA256 cc83286696e009813372a886f725409db43a657d75987ae90d4b96426b0090b6
MD5 aa7dfb45966ceb1c55316228dcffc5a6
BLAKE2b-256 08b4ba2cf20131d921884cc0bfb639f91a8c439b3272d9289e4442fabc93c881

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commonground_api_common-1.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ce2dd0a22b6589ea540afb391af1f2c4aad6cce2f37bb3aaa7c6fa923d1dcdd
MD5 149b67c3d7eee8b60676c5a2928a46b0
BLAKE2b-256 a2712d83859fb52d5f23a78da6e892c7a7e104112e4a858289d0e196811ed751

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