Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 5.65 KB

README.rst

File metadata and controls

139 lines (96 loc) · 5.65 KB

Referentielijsten API

Version: 0.2.0
Source:https://github.com/maykinmedia/referentielijsten
Keywords:referentielijsten, stamtabellen

Documentation Status Docker image

De Referentielijsten API is een generieke API voor eenvoudige herbruikebare lijsten (English version)

Ontwikkeld en gefinancierd door Maykin B.V..

Introductie

Er zijn op dit moment 3 initiatieven voor referentielijsten. In de VNG API standaard voor Zaakgericht Werken is een variant aanwezig die nooit is geformaliseerd. In het VNG initiatief voor een Klantinteracties API is ook een variant die net even afwijkt en ook niet formeel is vastgesteld. Ten slotte is er nog de Objecten API, die voor dit doel soms gebruikt wordt. Deze kan echter geen uniekheid afdwingen van items in de lijst en bevat teveel vrijheid in de attributen.

Vandaar dat er is gekozen voor een generieke aanpak voor referentielijsten, die zijn eigen API verdient. De API is bedoeld als registratie van herbruikbare lijsten waarbij de waarden van deze lijsten mag worden opgeslagen in andere registraties. Dit voorkomt onnodige calls naar deze API voor enkel een tekstuele waarde.

API specificatie

Lint OAS Generate SDKs Generate Postman collection

Versie Release datum API specificatie
latest n/a ReDoc, Swagger, (verschillen)
0.1.0 2024-05-28 ReDoc, Swagger

Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht.

Zie: Alle versies en wijzigingen

Ontwikkelaars

Build status Coverage Code style Docker image Supported Python version

Deze repository bevat de broncode voor Referentielijsten API. Om snel aan de slag te gaan, raden we aan om de Docker image te gebruiken. Uiteraard kan je ook het project zelf bouwen van de broncode. Zie hiervoor INSTALL.rst.

Quickstart

  1. Download en start Referentielijsten API:

    $ wget https://raw.githubusercontent.com/maykinmedia/referentielijsten/master/docker-compose.yml
    $ docker-compose up -d --no-build
    $ docker-compose exec web src/manage.py loaddata demodata
    $ docker-compose exec web src/manage.py createsuperuser
  2. In de browser, navigeer naar http://localhost:8000/ om de beheerinterface en de API te benaderen.

Links

Licentie

Copyright © Maykin 2024

Licensed under the EUPL