HTTP(S) & API:er

Ett anrop, ett svar

Ett API är ett gränssnitt mellan program. Med HTTP skickar klienten en request med metod, sökväg, headers och ibland en body. Serverns response innehåller statuskod, headers och ibland en body. En endpoint är en åtkomlig del av gränssnittet.

POST /api/readings
Content-Type: application/json

{"sensorId":"temp-01","value":21.7,"unit":"C"}

HTTP/1.1 201 Created

Låt metoden uttrycka avsikten

GET läser en resurs. POST används ofta för att skapa data. PUT ersätter en känd resurs, och DELETE tar bort den. Dokumentera metod, sökväg, obligatoriska headers, dataformat och möjliga svar för varje endpoint.

• 200: anropet lyckades.
• 201: en resurs skapades.
• 400: begäran är ogiltig.
• 404: resursen saknas.
• 415: innehållstypen stöds inte.
• 500: oväntat serverfel.

REST och SOAP

REST är en arkitekturstil med resurser, enhetliga gränssnitt och tillståndslösa anrop. Varje request innehåller den information som behövs. JSON är vanligt, men REST kräver inte JSON.

SOAP är ett XML-baserat meddelandeprotokoll med ett Envelope som innehåller en Body och valfri Header. WSDL används ofta som formellt kontrakt. En adapter kan knyta ihop ett modernt REST-API och ett befintligt SOAP-system.

Från HTTP till HTTPS

HTTPS skyddar HTTP med TLS. Det hjälper till att hålla innehållet hemligt, upptäcka ändringar och verifiera serverns identitet. Tjänsten måste fortfarande avgöra vem som får läsa eller ändra en resurs.

I IoT kan sensorn skicka till en gateway medan appar läser senaste mätningen via ett API. Diagnostik och konfiguration kan också exponeras lokalt på en enhet.