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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file commonground_api_common-2.0.1.tar.gz.

File metadata

File hashes

Hashes for commonground_api_common-2.0.1.tar.gz
Algorithm Hash digest
SHA256 4db5bb961b71582bc09d014a8b13025457d20663fcf372f2d0c6bbf236c118cf
MD5 3292181c3d9d5149495c2fbf9b38ab9b
BLAKE2b-256 8ca445fd967fd50626703a7881c819c7d0a7752dbbed99a4315d9d96334d818a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commonground_api_common-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 563d9755aab0f41a98e1becb6377df1f4495d608c4bdecf9c12bbec7f0dd37e6
MD5 d57404dce5f3099fb55a8167cdcd7bce
BLAKE2b-256 5ed6b73ab8c914f07a6ca5e34d65de1a272fe2d84b9b0ea7feb136f6b80f4a9b

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