Instansstrategi
APIer skall finnas i tre instanser:
Sandbox - en mockad testversion som returnerar statiska svar (inga integrationer mot andra applikationer eller system)
Test - en testversion som integrerar mot andra applikationers eller systems testmiljöer
Produktion - produktionsversion som integrerar mot andra applikationers eller systems produktionsmiljöer
Versionshantering
Observera 1: detta gäller produktionsmiljön!
Observera 2: om ett API säkras med API Key så måste respektive klient få en ny nyckel skapad för den nya versionen av APIet!
Ett API skall versionshanteras i två nivåer (exempel: 1.0)
En API-förändring som bryter kontraktet (som gör att APIet inte är bakåtkompatibelt) skall resultera i att man stegar upp huvudversionen (från till exempel 1.0 till 2.0)
En API-förändring som endast lägger till nya resurser eller parametrar till ett API (som gör att APIet är bakåtkompatibelt) skall resultera i att man stegar upp inom huvudversionen (från till exempel 1.0 till 1.1)
Hur konfigurerar vi APIer i API Manager?
Version | API Gateway | Token |
Produktion | Produktion | |
Test | Produktion | |
Sandbox | Sandbox |
Test
Konfigureras i API Publisher Test (https://api-im-test.sundsvall.se/publisher/apis).
Sandbox Endpoint skall peka på Sandbox-versionen av mikrotjänsten/applikationen
Production Endpoint skall peka på testversionen av mikrotjänsten/applikationen
Produktion
Konfigureras i API Publisher produktion (https://api-im.sundsvall.se/publisher/apis).
Production Endpoint skall peka på produktionsversionen av mikrotjänsten/applikationen