Versions Compared

Key

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

Denne side beskriver reglerne, som gælder for REST services udstillet af komponenterne på NSP.

Info
1 § REST services skal kunne modtage og svare med beskeder, der er formateret som JSON. Svaret skal indeholde http header: "Content-Type: application/json".

...

Info

2 § En REST service skal anvende HTTP verberne som følger:


HTTP GET: Anvendes til at hente information.
HTTP POST: Anvendes til at oprettet oprette nye ressourcer.
HTTP PUT: Anvendes til at udskifte hele en eksisterende ressource.
HTTP PATCH: Anvendes til at opdatere enkelte dele af en eksisterende ressource.
HTTP DELETE: Anvendes til at slette ressourcer.

...

Info
7 § Såfremt der er behov for at versionere en REST service, skal versionsnummeret være det første element i URL’ens path del.

Eksempelvis "v1/aftaler" og "v22020/02/24/aftaler". Versioner med dato istedet vX, hvor snitfladen er versioneret som Namespaces, se 2.9.5 § i Husregler for udvikling til NSP#Webservices.
 Her kan der benyttes et servlet filter til at få fat i versionen, og placere den på en servlet context. Den kan således anvendes til at skelne mellem forskellig logik på tværs af versioner.

...

Info
9 § Ved fejl transaktion returneres passende HTTP statuskode.

Standard HTTP statuskoderne benyttes til dette formål. Ved klient fejl returneres en HTTP 4xx fejlkode, og ved server fejl en HTTP 5xx fejlkode. 

...