Die ersten 5 Dinge, die Sie ausprobieren sollten, wenn Sie neu bei Apigit sind

Bei Apigit bemühen wir uns, APIs zu demokratisieren und Benutzern die Möglichkeit zu geben, APIs mit der Apigit API-Plattform zu nutzen und zu erstellen, um eine florierende API-First-Welt zu ermöglichen. Mit über Zehntausenden von Benutzern bauen wir unsere Reichweite weiter aus und bieten Zugang zu den besten Möglichkeiten, die Apigit zu bieten hat – von Neulingen bis hin zu fortgeschrittenen Benutzern.

Um auf eine der unten aufgeführten spezifischen Funktionen zugreifen zu können, müssen Sie zunächst ein Apigit-Konto erstellen und sich anmelden. Auf Apigit kann direkt von Ihrem bevorzugten Browser aus zugegriffen werden.

Nachdem Sie sich angemeldet haben, können Sie diese fünf aufregenden Funktionen erkunden, um mit Apigit loszulegen.

1. Erstellen Sie ein Repository

Nachdem Sie Ihr Apigit-Konto erstellt haben, können Sie die verschiedenen Funktionen der Plattform erkunden, einschließlich der Erstellung eines Repositorys. Ein Repository ist ein Bereich, in dem Sie Ihren Code speichern und mit anderen zusammenarbeiten können.

Navigieren Sie zum Erstellen eines Repositorys zum oberen Rand Ihres Apigit-Dashboards und klicken Sie auf+ Zeichen. Wählen Sie im Dropdown-Menü ausNew repository. Auf der nächsten Seite werden Sie aufgefordert, einen Namen und optional eine Beschreibung für Ihr Repository einzugeben. Nachdem Sie diese Informationen angegeben haben, klicken Sie auf die Schaltfläche "Repository erstellen", um den Vorgang abzuschließen.

Herzlichen Glückwunsch, Sie haben erfolgreich Ihr erstes Repository auf Apigit erstellt! Sie können jetzt damit beginnen, Dateien hinzuzufügen, mit anderen zusammenzuarbeiten und die vielen anderen Funktionen der Plattform zu nutzen.

Erster Schritt: Erstellen Sie ein Repository

2. Fügen Sie eine API-Spezifikation hinzu

Um Ihrem Apigit-Dashboard eine API-Spezifikation hinzuzufügen, klicken Sie auf die+ Zeichen befindet sich in der oberen linken Ecke. Geben Sie einen Pfadnamen ein, ztest/myfirst.json, zusammen mit anderen relevanten Informationen wie ztitle Undversion.

Bevor Sie eine neue API-Spezifikation hinzufügen, sollten Sie sich das in Ihrem Repository bereitgestellte Beispiel ansehen. Durch Klicken auf das 🪄-Symbol in der linken Seitenleiste können Sie zu einem anderen Viewer wechseln. Sie können zum Beispiel die auswählenpetstore-json-format.json Datei aus derexamples Ordner und wechseln Sie den Viewer zucode , um den JSON-Formatcode für die Beispielspezifikation anzuzeigen.

Um Ihre API-Spezifikation zu bearbeiten, bewegen Sie die Maus über die Datei und klicken Sie auf die⋮ Symbol am Ende der Datei oder klicken Sie auf das Symbol ✏️ unten links im Dashboard. Anschließend können Sie den JSON-Code aus dem Beispiel kopieren und zum Erstellen Ihrer eigenen Spezifikation verwenden. Hier ist ein Beispiel dafür, wie Ihre erste API-Spezifikation aussehen könnte.

Zweiter Schritt: Fügen Sie eine API-Spezifikation hinzu

3. Erstellen und veröffentlichen Sie einen Mock-Server

Mock-Server werden häufig in der API-Entwicklung verwendet, um das Verhalten einer API zu simulieren, bevor sie vollständig implementiert ist. Entwickler können Mock-Server verwenden, um ihren Code zu testen und sicherzustellen, dass er wie erwartet funktioniert, ohne auf die Fertigstellung der API warten oder Anfragen an einen echten Server stellen zu müssen.

Das Bereitstellen eines Mock-Servers in Apigit ist ein einfacher Vorgang. Navigieren Sie zunächst zu Ihrem Repository und klicken Sie auf dieMock Server Script Taste. Nachdem Sie Ihr Serverskript fertiggestellt haben, veröffentlichen Sie den Server. Die Server-URL finden Sie dann in derMock Servers Seite im oberen Menü.

Dritter Schritt: Erstellen und veröffentlichen Sie einen Mock-Server

4. Erstellen und veröffentlichen Sie einen API-Test

Beim API-Testen wird überprüft, ob APIs ihren Spezifikationen entsprechen, verschiedene Arten von Eingaben und Ausgaben verarbeiten und Fehler und Ausnahmen ordnungsgemäß behandeln können. API-Tests können manuell oder mit automatisierten Tools durchgeführt werden, die Anfragen und Antworten an die API simulieren.

Um mit dem API-Testen auf Apigit zu beginnen, klicken Sie auf dieTest Cases Schaltfläche, die sich unter Ihrem Repository befindet. Hier finden Sie API-Testbeispiele. Erstellen Sie Ihren eigenen Testfall und ersetzen Sie diebaseurl mit der in Schritt 3 generierten Mock-Server-URL.

Sobald Sie Ihren API-Testfall veröffentlicht haben, können Sie ihn auf der finden und ausführenAPI Testing Buchseite. Sie können diese Seite aufrufen, indem Sie auf klickenAPI Testing Schaltfläche im oberen Menü.

Vierter Schritt: Erstellen und veröffentlichen Sie einen API-Test

5. Teilen Sie Ihre Arbeit

Apigit ist eine beliebte API-Kollaborationsplattform, die eine einfache Arbeitsteilung ermöglicht. Egal, ob Sie mit einem einzelnen Freund an einem kleinen Projekt arbeiten oder Teil eines Großunternehmens mit Hunderten von Entwicklern sind, die aktiv an einer öffentlichen API arbeiten, Sie haben die Kontrolle darüber, was für wen sichtbar ist.

Wenn Sie etwas erstellt haben, von dem Sie glauben, dass es die Welt sehen sollte, können Sie es im Apigit-API-Netzwerk veröffentlichen. Dadurch können Apigit-Benutzer weltweit auf Ihre Sammlung zugreifen.

Erkunden Sie weiter – zum nächsten Level

Nachdem Sie nun einige der Grundlagen beherrschen, nehmen Sie sich etwas Zeit, um weitere nützliche Funktionen von Apigit zu erkunden und zu entdecken. Wussten Sie zum Beispiel, dass Sie einen API-Testfall entwerfen können, der vom Ergebnis einer anderen API abhängt? Entdecken Sie dieses und viele andere hilfreiche Tools, die auf der Plattform verfügbar sind.