Publiser metadata om tilgjengelige tjenester i _links i tråd med HATEOAS?

unioslo / mreg

GNU General Public License v3.0

7 stars 13 forks source link

Publiser metadata om tilgjengelige tjenester i _links i tråd med HATEOAS? #277

Open petterreinholdtsen opened 5 years ago

petterreinholdtsen commented 5 years ago

Kan det være en ide å gjøre det mulig å finne frem i API-et ved å besøke toppnivået og se hva slags tjenester som er tilgjengelig, i tråd med HATEOAS-prinsippene og ved å følge forslaget i JDON Hypertext Application Language-utkastet?

Mer om HATEOAS kan finnes på Wikipedia.

Dette er litt relatert til #56, om automatisk dokumentasjon av API-et.

oyvindkolbu commented 5 years ago

Nå har vi API-dokumentasjon (swagger) på /docs/. Du mener da å f.eks flytte den til rotnivå?