Versions Compared

Version Old Version 2 New Version 3
Changes made by

Alex Post

Alex Post

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Binnen een API applicatie heb je ook de mogelijkheid om metadata vast te leggen. Dit heeft als grote voordeel dat binnen de U-Turn met deze metadata een aantal zaken voor je op de achtergrond geregeld kunnen worden, denk aan bijvoorbeeld de hele lijst met endpoints die een bepaalde API bevat.

Info

Metadata voor een API verwijst naar de informatie die wordt gebruikt om de structuur, functionaliteit en eigenschappen van de API zelf te beschrijven. Het zijn gegevens die extra context en details bieden over hoe de API werkt en hoe deze kan worden gebruikt.

Metadata bevat veelal:

  1. Endpoint-informatie: Dit omvat details over de URL's (endpoints) waarmee de API kan worden benaderd. Het kan aangeven welke HTTP-methoden kunnen worden gebruikt, zoals GET, POST, PUT of DELETE, en welke parameters moeten worden doorgegeven.

  2. Gegevensindeling: Metadata kan aangeven welke indeling wordt gebruikt om gegevens uit te wisselen, zoals JSON (JavaScript Object Notation) of XML (eXtensible Markup Language). Het kan ook de structuur van de gegevens beschrijven, inclusief de beschikbare velden, hun typen en eventuele beperkingen of validatieregels.

...

Ga na of de applicatie die je toe wil voegen een metadata endpoint heeft of niet. Wanneer deze beschikbaar is kan je deze hier opgeven.

...