‫Sprecher: Unsere API ist nun also im Grunde fertig.
‫In diesem letzten Video
‫des Abschnitts werden wir schnell eine
‫Dokumentation für API direkt in Postman erstellen.
‫Und das ist richtig, wir
‫können ganz einfach eine schnelle Dokumentation direkt in Postman erstellen.
‫Und es ist wirklich wichtig, eine API-Dokumentation
‫zu haben, denn auf diese Weise kommunizieren wir den Teammitgliedern oder
‫sogar unseren Endbenutzern der API, wie sie sie
‫in der Praxis verwenden können.
‫Lassen Sie mich Ihnen jetzt zeigen, wie es funktioniert.
‫Bevor wir nun tatsächlich die Dokumentation erstellen können,
‫lassen Sie uns hier einfach aufräumen.
‫Löschen Sie beispielsweise diese Anfrage, in Ordnung?
‫Eine andere Sache, die ich tun möchte, ist hier im
‫Anmeldepunkt, wir geben hier tatsächlich unser Passwort frei.
‫Das ist keine gute Idee, und ich
‫werde eine Umgebungsvariable erstellen, die
‫dieses Kennwort enthält.
‫Da es immer das Gleiche ist, sollte das kein Problem sein.
‫Denken Sie also daran, wie wir das tun.
‫Nun, wir kommen hier zum Umweltmanagement
‫und fügen hier einfach noch einen hinzu.
‫Also Passwort test1234.
‫Und hier ist dies nicht korrekt, also Passwort aktualisiert, und jetzt machen
‫wir dasselbe auch hier
‫in der Produktion.
‫Also Passwort test1234.
‫Also, nicht hinzufügen, aber schließen wir das und so
‫kann ich das jetzt hinzufügen und verwenden,
‫nicht in einem String, sondern so.
‫Also Passwort.
‫Versuchen wir es also.
‫Und das gibt uns diesen seltsamen Fehler,
‫aber unser Passwort ist tatsächlich hier,
‫also müssen wir wahrscheinlich wirklich die Anführungszeichen hier einfügen.
‫Versuchen wir es also.
‫Und so sind wir nun tatsächlich erfolgreich eingeloggt.
‫Also spar dir das jetzt, okay?
‫Was wir jetzt also tun sollten, ist, für jede
‫einzelne Anfrage, die wir in unserer Sammlung
‫haben, eine Beschreibung zu erstellen.
‫Das werde ich jetzt natürlich nicht
‫tun, ich werde es hier nur mit dem ersten veranschaulichen.
‫Okay?
‫Also lassen Sie uns diese anderen
‫tatsächlich schließen und jetzt können wir hier eine Beschreibung hinzufügen.
‫Sagen wir einfach, verwenden Sie diesen Endpunkt,
‫um eine neue Tour zu erstellen.
‫Okay, und Sie sollten jetzt genau dasselbe für alle Ihre Anfragen
‫tun, wenn Ihr Ziel darin besteht, Ihre API wirklich
‫zu veröffentlichen und zu teilen, okay?
‫Dann gilt das gleiche für Ordner, und zwar
‫nicht zum Umbenennen, sondern zum Bearbeiten.
‫Und so können wir
‫in jedem dieser Ordner eigentlich auch eine Beschreibung hinzufügen.
‫Sagen wir einfach etwas Zufälliges wie, Sie
‫können alle Touren abrufen, neue
‫erstellen
‫und Touren bearbeiten und löschen.
‫Für einige spezielle Anforderungen gibt es auch
‫spezielle Endpunkte.
‫Okay, also das ist immer wieder total
‫zufällig und ich würde so etwas für meine eigene API veröffentlichen,
‫aber hier wollen wir wirklich nur testen, wie es funktioniert, okay?
‫Wie Sie hier unten
‫sehen können, können Sie auch Mark hier unten verwenden, okay?
‫Um zum Beispiel Text fett zu
‫machen, können Sie denken, dass es so funktioniert, ja,
‫es sieht so aus, und
‫ja, ja, Sie können hier alle möglichen Dinge tun, okay?
‫Sie können wahrscheinlich
‫auch eine Beschreibung zu
‫Natours selbst erstellen. Nehmen wir an, die
‫Natours-API enthält Endpunkte für Touren, Benutzer und Bewertungen.
‫Und dann wieder eine
‫Menge Zeug, wie Sie Ihren Authentifizierungsprozess oder Ihre
‫Berechtigungen beschreiben könnten und wirklich alles, was
‫der Benutzer wissen muss, um diese API zu verwenden, okay?
‫Sie sollten also
‫immer zu allen Anfragen, zu allen Ordnern und
‫natürlich auch zur Sammlung selbst eine Beschreibung hinzufügen.
‫Oh, und wir können die Abfrageparameter tatsächlich in einer Abfragezeichenfolge beschreiben, also
‫lassen Sie uns das hier tun.
‫Und wir können auch sagen, dass es größer
‫als, kleiner als gleich, größer als und kleiner als Operatoren unterstützt.
‫Also noch einmal hier nur ein
‫Beispiel und speichern wir es jetzt in der Anfrage ab.
‫Und damit denke ich, sollten
‫wir bereit sein, unsere API-Dokumentation tatsächlich zu veröffentlichen.
‫Um das zu tun, gehen wir
‫einfach hier zur Option Sammlungen und veröffentlichen
‫dann hier unten Dokumentationen.
‫Und so sollte sich dann ein Browserfenster öffnen, und bei
‫mir geschah es außerhalb meines Bildschirms,
‫also lassen Sie mich das einfach hierher bringen.
‫Und so können Sie jetzt die Umgebung auswählen.
‫Hier sollten wir also eine Liste unserer Umgebungen haben,
‫die wir aus irgendeinem Grund nicht haben, das ist seltsam, aber
‫wir wollten sowieso keine Umgebung verwenden, weil das dann
‫unsere Umgebungsvariablen durch ihre
‫echten Werte ersetzen würde, und das wollen
‫wir nicht.
‫Zum Beispiel haben wir die Umgebungsvariable
‫für das Passwort verwendet, damit
‫sie später in der Dokumentation nicht wirklich sichtbar ist, okay?
‫Wir wollen also wirklich keine Umgebung nutzen.
‫Jetzt könnten wir auch eine
‫benutzerdefinierte Domain verwenden, aber das ist nur für zahlende Benutzer, okay?
‫Dann könnten wir auch das gesamte Styling der
‫API ändern, um es an Ihre Markenfarben anzupassen, aber auch
‫das ist in diesem Fall nicht
‫notwendig, also lassen Sie uns es tatsächlich veröffentlichen.
‫Dies ist nun tatsächlich öffentlich,
‫sodass jeder Ihre Dokumentation jetzt unter dieser URL anzeigen kann.
‫Aus irgendeinem Grund wurden nicht alle Änderungen aktualisiert, die wir zuvor
‫vorgenommen haben, also ist das ein bisschen seltsam.
‫Gehen wir also zurück zu Postman und
‫sehen, was los ist.
‫Vielleicht hat es mit diesem rotierenden Ding hier zu tun, also werde ich
‫Postman einfach beenden und es wieder öffnen.
‫Und hoffen wir, dass es damit behoben ist.
‫Also wenn wir jetzt hier neu
‫laden, ahh dann bekommen wir eigentlich alle unsere Änderungen hier.
‫Sie sehen also die Beschreibung,
‫die wir für die Natours-Kollektion hinzugefügt haben, okay?
‫Dann auch die Beschreibung für diesen Ordner und
‫die Beschreibung für diese Anfrage.
‫Und zum Schluss als
‫erste Beschreibung auch für diesen Parameter, okay?
‫Hier erhalten wir dann die URL-Umgebungsvariable anstelle
‫der eigentlichen URL.
‫Nun möchten Sie natürlich hier die
‫echte URL angeben und
‫dafür einfach eine andere Umgebung verwenden.
‫Hier oben können Sie also tatsächlich alle Umgebungen
‫sehen, aber sie sind privat, also kann sie im Moment niemand
‫benutzen, aber denken
‫Sie daran, dass wir im ersten Schritt
‫diese Dokumentation tatsächlich mit einer der Umgebungen hätten erstellen
‫können, und wahrscheinlich würden wir das tun haben
‫die Produktionsumgebung dafür verwendet und damit hätten wir dann
‫die endgültige Produktions-URL hier in unseren API-URLs, okay?
‫Jedenfalls sieht die Dokumentation so
‫aus, also hier die Beispielanfrage und wir können
‫das auch in unsere eigene Sprache ändern.
‫In diesem Fall also Node JS,
‫aber wenn der Benutzer beispielsweise eine Anfrage
‫mit jQuery durchführt, kann er einfach jQuery verwenden, okay.
‫Also nur um diese Beispielanfrage hier zu sehen, mit Node sieht es
‫ungefähr so aus.
‫Hier haben wir also alle
‫unsere Endpunkte und Sie können sehen, dass diejenigen, die
‫eine Authentifizierung erfordern, tatsächlich dieses Schlosssymbol hier haben.
‫Und so könnten Sie in Ihrer Beschreibung nun
‫den Spruch hinzufügen, dass Sie sich anmelden müssen, um auf diesen Endpunkt
‫zuzugreifen, und auch, wie Sie sich tatsächlich anmelden können, okay.
‫Oder Sie können
‫das auch hier im Abschnitt Authentifizierung beschreiben, oder?
‫Idealerweise haben Sie also Beschreibungen für all dies.
‫Oh, und hier sehe
‫ich, dass wir tatsächlich vergessen haben, das echte Passwort zu
‫ersetzen, aber egal, da dies wirklich nur ein Beispiel ist, okay?
‫Aber natürlich bekommen Sie auch
‫hier alle Anfragen, die wir in unserem Postboten hatten.
‫Ein weiteres nettes Feature hier ist diese Run in
‫Postman-Schaltfläche. Wenn also jemand Postman auf seinem
‫Computer installiert hat, muss er
‫nur hier klicken und dann mit seiner Postman-Anwendung öffnen.
‫Das mache ich jetzt jetzt nicht,
‫weil ich es natürlich schon in meinem Postman habe, aber
‫ansonsten ist dies ein wirklich nettes Feature für die Benutzer,
‫um dann sofort mit Ihrer API zu experimentieren.
‫Okay, und ich denke, das war es eigentlich, damit
‫ist unser Abschnitt abgeschlossen
‫und unsere API ist jetzt endlich wirklich fertig.
‫Nochmals herzlichen Glückwunsch, dass Sie es so weit in den
‫Kurs geschafft haben, wir haben
‫hier schon so viel gemeinsam zurückgelegt.
‫Als nächstes steht ein sehr, sehr spannender Abschnitt
‫bevor, in dem wir endlich
‫die Benutzeroberfläche für die Natours-Website erstellen werden.
‫Im Grunde werden wir also Vorlagen
‫verwenden, um eine vollständig dynamische Website basierend auf allen Daten
‫zu erstellen, die wir bereits in unserer Datenbank haben.
‫Und das ist wirklich cool.
‫Und so kann ich es kaum erwarten, Ihnen das zu zeigen.