Informatievlaanderen / generieke-hypermedia-api

Bouwen van een specificatie van generieke bouwblokken voor API’s in Vlaanderen
8 stars 4 forks source link

CRUD acties #6

Open pietercolpaert opened 6 years ago

pietercolpaert commented 6 years ago

Beschrijven van CRUD acties kan ook via verschillende specificaties:

  1. Linked Data Platform (en Linked Data Notifications)
  2. Hydra CG: https://github.com/HydraCG/Specifications/tree/master/drafts/use-cases
rubensworks commented 6 years ago

Verwant hiermee is ook de optie op meerdere acties te beschrijven binnen één interface, en manieren waarop deze acties kunnen onderscheiden worden.

Een mogelijke manier om deze te onderscheiden is door bijvoorbeeld hun response-structuur declaratief te beschrijven.

pietercolpaert commented 6 years ago

Mogelijks interessant voor semantische niveau: paper of LDP + Hydra samen: http://ceur-ws.org/Vol-1359/paper5.pdf

pietercolpaert commented 6 years ago

Voor niet semantische data (maar ook semantische data), ondersteuning voor JSON API (http://jsonapi.org/format/#crud)?

jensscheerlinck commented 6 years ago

Hoe adverteert JSON API welke operaties mogelijk zijn op een bepaalde resource?

brechtvdv commented 6 years ago

Ik zou hydra:returns bij operaties ook toevoegen, bijvoorbeeld:

{
  "@context": "http://www.w3.org/ns/hydra/context.jsonld",
  "@id": "/api/resource/1",
  "title": "Een voorbeeld resource",
  "description": "Deze resource kan opgehaald worden met een HTTP GET request",
  "operation": [
    {
      "@type": "Operation",
      "method": "GET"
      "returns": "http://example.org#exampleShape"
    }

Is er een reden waarom dit niet toegevoegd is?