Die OptiSigns API ist um GraphQL herum organisiert. GraphQL ist eine Abfragesprache für APIs, sie bietet eine vollständige und verständliche Beschreibung der Daten in der API, gibt Clients die Möglichkeit, genau das anzufordern, was sie benötigen und nicht mehr, macht es einfacher, APIs im Laufe der Zeit weiterzuentwickeln und ermöglicht leistungsstarke Entwicklertools.
Warum GraphQL
Nur ein API-Endpunkt
GraphQL-APIs sind in Form von Typen und Feldern organisiert, nicht von Endpunkten. Greifen Sie über einen einzigen Endpunkt auf die vollständigen Funktionen Ihrer Daten zu. GraphQL verwendet Typen, um sicherzustellen, dass Apps nur nach dem fragen, was möglich ist, und um klare und hilfreiche Fehler zu liefern. Apps können Typen verwenden, um das Schreiben von manuellem Parsing-Code zu vermeiden.
Viele Ressourcen in einer einzigen Anfrage abrufen
GraphQL-Abfragen greifen nicht nur auf die Eigenschaften einer Ressource zu, sondern folgen auch nahtlos Referenzen zwischen ihnen. Während typische REST-APIs das Laden von mehreren URLs erfordern, erhalten GraphQL-APIs alle Daten, die Ihre App benötigt, in einer einzigen Anfrage. Apps, die GraphQL verwenden, können selbst bei langsamen mobilen Netzwerkverbindungen schnell sein.
Kein Over-Fetching und Under-Fetching
Senden Sie eine GraphQL-Abfrage an Ihre API und erhalten Sie genau das, was Sie benötigen, nicht mehr und nicht weniger. GraphQL-Abfragen liefern immer vorhersehbare Ergebnisse. Apps, die GraphQL verwenden, sind schnell und stabil, weil sie die Daten kontrollieren, die sie erhalten, nicht der Server.
Keine Versionierung
Neue Felder und Typen können zur GraphQL-API hinzugefügt werden, ohne bestehende Abfragen zu beeinflussen. Veraltete Felder können als veraltet markiert und vor Tools verborgen werden. Durch die Verwendung einer einzigen, sich entwickelnden Version geben GraphQL-APIs Apps kontinuierlichen Zugriff auf neue Funktionen und fördern saubereren, wartungsfreundlicheren Servercode.
OptiSigns API-Endpunkt
Auf die GraphQL-API kann über den Endpunkt zugegriffen werden.
https://graphql-gateway.optisigns.com
Wir bieten auch eine webbasierte GraphQL-IDE für den Zugriff auf unsere API.
https://graphql-gateway.optisigns.com/graphql
Nächster Artikel - API-Schlüssel generieren und verwalten