OptiSigns API är organiserat kring GraphQL. GraphQL är ett frågespråk för API:er, det ger en komplett och förståelig beskrivning av data i API:et, ger klienter möjlighet att be om exakt vad de behöver och inget mer, gör det enklare att utveckla API:er över tid och möjliggör kraftfulla utvecklarverktyg.
Varför GraphQL
Endast en API-endpoint
GraphQL API:er är organiserade i termer av typer och fält, inte endpoints. Få tillgång till dina datas fulla kapacitet från en enda endpoint. GraphQL använder typer för att säkerställa att appar bara frågar efter det som är möjligt och ger tydliga och hjälpsamma felmeddelanden. Appar kan använda typer för att undvika att skriva manuell parseringskod.
Hämta många resurser i en enda förfrågan
GraphQL-frågor får inte bara tillgång till egenskaper för en resurs utan följer också smidigt referenser mellan dem. Medan typiska REST API:er kräver laddning från flera URL:er, hämtar GraphQL API:er all data din app behöver i en enda förfrågan. Appar som använder GraphQL kan vara snabba även på långsamma mobila nätverksanslutningar.
Ingen överhämtning och underhämtning
Skicka en GraphQL-fråga till ditt API och få exakt vad du behöver, varken mer eller mindre. GraphQL-frågor returnerar alltid förutsägbara resultat. Appar som använder GraphQL är snabba och stabila eftersom de kontrollerar vilken data de får, inte servern.
Ingen versionering
Nya fält och typer kan läggas till i GraphQL API utan att påverka befintliga frågor. Föråldrade fält kan fasas ut och döljas från verktyg. Genom att använda en enda utvecklande version ger GraphQL API:er appar kontinuerlig tillgång till nya funktioner och uppmuntrar renare, mer underhållbar serverkod.
OptiSigns API-endpoint
GraphQL API:et kan nås via endpoint.
https://graphql-gateway.optisigns.com
Vi erbjuder också en webbaserad GraphQL IDE för att komma åt vårt API.
https://graphql-gateway.optisigns.com/graphql
Nästa artikel - Generera och hantera API-nyckel