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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for commonground_api_common-2.0.0.tar.gz
Algorithm Hash digest
SHA256 daa6ae02ed6a145f7a2d909993c8b32493f83aeeb5b52fe236106d9407b058bf
MD5 33e2be34a6fc38accb1765bbf8c3b48c
BLAKE2b-256 d5aedad50ebd79d73686b0993bad067327b8d5561f64aac12453c2a2518c428c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commonground_api_common-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d28a574175cc0ad47369736bab712e29b04ed5aede90a9fef376d4d3e34adc4b
MD5 a1fce19fe15150ace67f42c955895ae2
BLAKE2b-256 978059eac0de844fd5ad7d4d906ade09558994b3fb24bb0b5b3af993d07d83b2

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