Hallo! Als API -Lieferant (aktiver pharmazeutischer Inhaltsstoff) werde ich oft gefragt, was ein API -Schema ist. Also dachte ich, ich würde mir etwas Zeit nehmen, um es für Sie auf eine Weise aufzubrechen, die leicht zu verstehen ist.
Beginnen wir mit den Grundlagen. Ein API -Schema ist wie eine Blaupause für eine API. Es handelt sich um eine detaillierte Beschreibung, wie eine API funktioniert, welche Daten sie erwarten und welche Daten sie zurückgeben. Stellen Sie sich dies als eine Reihe von Regeln und Richtlinien vor, die sowohl der API -Anbieter (das bin ich!) Als auch der API -Verbraucher (das sind Sie oder Ihr Team) folgen müssen, um eine reibungslose und effiziente Kommunikation zu gewährleisten.
Warum ist ein API -Schema wichtig?
Stellen Sie sich vor, Sie bauen ein Haus. Sie würden nicht einfach anfangen, Ziegel ohne Plan herumzuwerfen, oder? Gleiches gilt für APIs. Ein API -Schema bietet Entwicklern eine klare und konsistente Möglichkeit, die API zu verstehen und zu nutzen. Es hilft, Missverständnisse zu vermeiden, reduziert die Wahrscheinlichkeit von Fehlern und erleichtert es, die API in verschiedene Anwendungen zu integrieren.
Nehmen wir beispielsweise an, Sie sind ein Entwickler, der mit unserer API auf Informationen zugreifen möchteNanokalbonisierter Niob, Mikron-Niob-Carbid, Ultra-Fine-Niob-Carbid, HFC. Das API -Schema zeigt Ihnen genau an, welche Endpunkte verfügbar sind, welche Parameter Sie übergeben müssen und in welchem Format die Antwort sein wird. Dies erleichtert es Ihnen viel einfacher, den Code zu schreiben, um mit der API zu interagieren und die von Ihnen benötigten Daten zu erhalten.
Was ist in einem API -Schema?
Ein API -Schema enthält typischerweise die folgenden Komponenten:
1. Endpunkte
Dies sind die URLs, die Sie aufrufen können, um auf die Funktionalität der API zuzugreifen. Jeder Endpunkt repräsentiert eine bestimmte Operation, z. B. eine Liste von Produkten, eine neue Bestellung oder Aktualisierung von Benutzerinformationen.
2. Anforderungs- und Antwortformate
Das Schema definiert das Format der Daten, die Sie für Ihre Anfragen (z. B. JSON, XML) und das Format der Daten, die die API in ihren Antworten zurücksetzt, senden. Dies stellt sicher, dass sowohl der API -Anbieter als auch der Verbraucher auf derselben Seite sind, wenn es um die Datenbearbeitung geht.
3.. Parameter
Dies sind die Werte, die Sie an einen Endpunkt übergeben können, um den Vorgang anzupassen. Sie können beispielsweise eine Produkt -ID übergeben, um Informationen über ein bestimmtes Produkt oder einen Datumsbereich zu erhalten, um eine Liste von Bestellungen zu filtern.
4. Fehlerbehandlung
Das Schema wird auch beschreiben, wie die API mit Fehlern umgeht. Es definiert die Fehlercodes, die die API zurückgeben könnte und was jeder Code bedeutet. Dies hilft Entwicklern zu verstehen, was bei einem Fehler schief gelaufen ist und wie es behoben werden kann.
Arten von API -Schemata
Es gibt verschiedene Arten von API -Schemata mit jeweils eigenen Vorteilen und Anwendungsfällen. Einige der häufigsten sind:
OpenAPI -Spezifikation (OAS)
Dies ist einer der beliebtesten Standards für die Dokumentation erholsamer APIs. Es verwendet eine YAML- oder JSON -Datei, um die Endpunkte, Anforderungs- und Antwortformate der API, Parameter und mehr zu beschreiben. OAS wird von Tools und Frameworks häufig unterstützt, wodurch es einfach ist, Dokumentation, SDKs und Testfälle zu generieren.
GraphQL Schema
GraphQL ist eine Abfragesprache für APIs, mit der Clients genau die Daten anfordern können, die sie benötigen. Ein GraphQL -Schema definiert die Arten von Daten, die die API zurückgeben kann, und die Operationen, die an diesen Typen ausgeführt werden können. Es bietet eine flexiblere und effizientere Möglichkeit, um auf Daten zuzugreifen als herkömmliche erholsame APIs.
Protokollpuffer
Protokollpuffer (Protobuf) ist ein von Google entwickelter Sprach-Agnostic-binärer Serialisierungsformat. Es verwendet eine Schema -Datei, um die Struktur der Daten zu definieren, die serialisiert und deserialisiert werden. Protobuf ist bekannt für seine hohe Leistung und kleine Nachrichtengröße. Damit ist es eine beliebte Wahl für APIs, die große Datenmengen behandeln müssen.
Wie wir API -Schemas als API -Lieferant verwenden
Als API -Lieferant verlassen wir uns auf API -Schemata, um sicherzustellen, dass unsere APIs einfach zu verwenden und zu integrieren. Wir verwenden die OpenAPI -Spezifikation, um unsere APIs zu dokumentieren, mit der wir unseren Kunden klare und detaillierte Dokumentation bereitstellen können. Diese Dokumentation enthält Informationen zu den Endpunkten, Anforderungs- und Antwortformaten, Parametern und Fehlerbehandlung.
Wir verwenden auch API -Schemas, um die Anfragen zu validieren, die wir von unseren Kunden erhalten. Durch die Überprüfung der eingehenden Anfragen gegen das Schema können wir sicherstellen, dass die Daten im richtigen Format sind und dass alle erforderlichen Parameter vorhanden sind. Dies hilft, Fehler zu vermeiden und stellt sicher, dass unsere APIs zuverlässig und sicher sind.
Darüber hinaus verwenden wir API -Schemas, um SDKs und Testfälle zu generieren. Durch die Verwendung von Tools, die die OpenAPI -Spezifikation unterstützen, können wir automatisch Code in verschiedenen Programmiersprachen generieren, was es unseren Kunden erleichtert, unsere APIs in ihre Anwendungen zu integrieren. Wir verwenden auch das Schema, um Testfälle zu generieren, mit denen wir sicherstellen können, dass unsere APIs korrekt funktionieren und die Anforderungen unserer Kunden entsprechen.
Beispiele für reale Welt
Werfen wir einen Blick auf einige reale Beispiele dafür, wie API-Schemata verwendet werden.
Beispiel 1: Verwenden Sie unsere API, um Informationen darüber zu erhaltenHochwertige Thioxanthen-9-One CAS: 492-22-8
Angenommen, Sie sind ein Forscher, der Informationen über eine bestimmte chemische Verbindung erhalten möchte. Sie können unsere API verwenden, um auf Daten wie die Eigenschaften der Verbindung, die Synthesemethoden und die Sicherheitsinformationen zuzugreifen. Das API -Schema zeigt Ihnen genau an, welchen Endpunkt Sie aufrufen sollen, welche Parameter übergeben werden (z. B. die CAS -Nummer) und in welchem Format die Antwort sein wird.
Hier ist ein Beispiel für eine Anfrage an unsere API mit Curl:
curl -x erhalten "https://api.oursite.com/compounds/492-22-8" -h "Akzeptieren: Anwendung/JSON"Die Antwort könnte ungefähr so aussehen:
{ "name": "Thioxanthen-9-one", "cas_number": "492-22-8", "molecular_weight": 212.26, "properties": { "melting_point": "85-87°C", "boiling_point": "365.7°C at 760 mmHg" }, "synthesis_methods": [ "Method 1: Reagieren Sie x mit y in Gegenwart von Z ... "," Methode 2: Verwenden Sie die folgenden Reaktionsbedingungen ... "]}Beispiel 2: Erstellen einer neuen Bestellung fürCAS Nr. 455943-61-0 große Versorgung
Wenn Sie ein Pharmaunternehmen sind, der eine Bestellung für eine große Versorgung einer bestimmten API aufgeben möchte, können Sie unsere API verwenden, um eine neue Bestellung zu erstellen. Das API -Schema definiert den Endpunkt für die Erstellung einer Bestellung, das Anforderungsformat (z. B. die Auftragsdetails, die Menge und die Lieferadresse) und das Antwortformat (z. B. die Bestell -ID und Bestätigungsnachricht).
Hier ist ein Beispiel für eine Anfrage an unsere API mit Python:
Importieren uRl = "https://api.oursit.com/orders" data = {"product_id": "455943-61-0", "Menge": 1000, "lieferung_address": "123 Hauptst. Header = Header) Print (Antwort.json ())Die Antwort könnte ungefähr so aussehen:
{"Order_id": "123456", "Nachricht": "Reihenfolge erfolgreich erstellt. Ihre Bestellung wird innerhalb von 24 Stunden verarbeitet." }Abschluss
Zusammenfassend ist ein API -Schema ein entscheidender Bestandteil jeder API. Es bietet Entwicklern eine klare und konsistente Möglichkeit, die API zu verstehen und zu verwenden, reduziert die Wahrscheinlichkeit von Fehlern und erleichtert es, die API in verschiedene Anwendungen zu integrieren. Als API -Lieferant verlassen wir uns auf API -Schemata, um sicherzustellen, dass unsere APIs einfach zu bedienen, zuverlässig und sicher sind.
Wenn Sie daran interessiert sind, unsere APIs zu nutzen, um auf Informationen über unsere Produkte zuzugreifen oder Bestellungen zu erteilen, würden wir gerne von Ihnen hören. Egal, ob Sie ein Forscher, ein Pharmaunternehmen oder ein Entwickler sind, unsere APIs können Ihnen die Daten und Funktionen zur Verfügung stellen, die Sie benötigen. Zögern Sie also nicht, uns an uns zu wenden, um Ihre Anforderungen zu besprechen und den Beschaffungsprozess zu starten. Wir sind hier, um Ihnen dabei zu helfen, das Beste aus unseren APIs zu nutzen und sicherzustellen, dass Ihre Erfahrungen mit uns positiv sind.
Referenzen
- Fielding, RT (2000). Architekturstile und das Design von netzwerkbasierten Softwarearchitekturen. Universität von Kalifornien, Irvine.
- Khare, R. & Frystyk, H. (1997). Hypertexttransferprotokoll - HTTP/1.1. RFC 2068.
- Lindley, S. & Miller, B. (2015). GraphQL: Eine Datenabfragesprache. Facebook.
- Varda, A. (2008). Protokollpuffer: Das Datenaustauschformat von Google. Google Open Source -Blog.
