Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

  • Ett API skall tjäna som ingång till en väl avgränsad funktion och äga sin egen livscykel

  • Följ OpenAPI-specifikationen (https://swagger.io/specification/)

    • Supportera någon av

      • application/json

      • application/ld+json

    • Producera typade APIer

  • Schemat skall vara på engelska

  • Dela så lite data som möjligt i ditt API – endast data som är relevant för en klient skall delas, inget annat

  • Validera alltid alla in-parametrar i ett API-anrop (schema-validering), för att förhindra SQL-injektion och liknande

  • Vanligt förekommande parameter-namn skall specificeras på OpenAPI namnsättning samt återanvändas i samtliga APIer

  • Det är inte tillåtet att använda personnummer som parameter i våra APIer förutom i absoluta undantagsfall - använd personId i stället (se OpenAPI namnsättning )

  • Ett API skall exponeras i följande varianter:

    • Sandbox - en mockad version som returnerar statiska svar (som inte exekverar verksamhetslogik)

    • Test - en testversion som exekverar verksamhetslogik i testmiljö

    • Produktion - skarp version som exekverar verksamhetslogik i produktionsmiljöer

  • APIer skall versionshanteras

  • APIer skall dokumenteras på API-katalog

  • No labels