Demo API Component

• Version: 2.1.0
• Source: https://github.com/maykinmedia/demo-api-component
• Keywords: VNG, VNG-realisatie, demo, api
• PythonVersion: 3.6

Een voorbeeld van een OAS 3.0 API met bijbehorende referentie implementatie. Deze repository is hoofdzakelijk voor intern gebruik bij VNG.

De OAS 3.0 specificatie staat in de API specificatie repository_.

Inleiding

Om verschillende zaken gerelateerd aan het nieuwe API-landschap te begrijpen, beheren, ontwikkelen, uitrollen, testen, etc. kan deze repository gebruikt worden.

Het is een volledig werkende API met 1 resource en endpoint en is een vereenvoudigde weergave van allerlei (ontwerp)beslissingen aangaande gebruikte technieken zoals RESTful APIs, Docker, OAS 3.0, versiebeheer, etc.

Het component is te testen op de testomgeving_.

Documentatie

Zie INSTALL.rst voor installatie instructies en beschikbare commando's.

Referenties

• API specificatie repository_
• Issues <https://github.com/maykinmedia/demo-api-component/issues>_
• Code <https://github.com/maykinmedia/demo-api-component>_

.. |build-status| image:: http://jenkins.nlx.io/buildStatus/icon?job=demo-api-component-stable :alt: Build status :target: http://jenkins.nlx.io/job/demo-api-component-stable

.. |requirements| image:: https://requires.io/github/maykinmedia/demo-api-component/requirements.svg?branch=master :target: https://requires.io/github/maykinmedia/demo-api-component/requirements/?branch=master :alt: Requirements status

.. _testomgeving: https://ref.tst.vng.cloud/demo-api/ .. _API specificatie repository: https://github.com/maykinmedia/demo-api

Licentie

Copyright © VNG Realisatie 2019

Licensed under the EUPL_

.. _EUPL: LICENCE.md