1 00:00:01,100 --> 00:00:04,510 ‫Sprecher: Unsere API ist nun also im Grunde fertig. 2 00:00:04,510 --> 00:00:07,003 ‫In diesem letzten Video 3 00:00:07,003 --> 00:00:09,680 ‫des Abschnitts werden wir schnell eine 4 00:00:09,680 --> 00:00:13,020 ‫Dokumentation für API direkt in Postman erstellen. 5 00:00:13,020 --> 00:00:15,290 ‫Und das ist richtig, wir 6 00:00:15,290 --> 00:00:18,830 ‫können ganz einfach eine schnelle Dokumentation direkt in Postman erstellen. 7 00:00:18,830 --> 00:00:21,620 ‫Und es ist wirklich wichtig, eine API-Dokumentation 8 00:00:21,620 --> 00:00:25,870 ‫zu haben, denn auf diese Weise kommunizieren wir den Teammitgliedern oder 9 00:00:25,870 --> 00:00:29,140 ‫sogar unseren Endbenutzern der API, wie sie sie 10 00:00:29,140 --> 00:00:31,740 ‫in der Praxis verwenden können. 11 00:00:31,740 --> 00:00:33,973 ‫Lassen Sie mich Ihnen jetzt zeigen, wie es funktioniert. 12 00:00:35,490 --> 00:00:38,367 ‫Bevor wir nun tatsächlich die Dokumentation erstellen können, 13 00:00:38,367 --> 00:00:40,920 ‫lassen Sie uns hier einfach aufräumen. 14 00:00:40,920 --> 00:00:45,010 ‫Löschen Sie beispielsweise diese Anfrage, in Ordnung? 15 00:00:47,550 --> 00:00:51,490 ‫Eine andere Sache, die ich tun möchte, ist hier im 16 00:00:51,490 --> 00:00:55,180 ‫Anmeldepunkt, wir geben hier tatsächlich unser Passwort frei. 17 00:00:55,180 --> 00:00:58,220 ‫Das ist keine gute Idee, und ich 18 00:00:58,220 --> 00:01:00,350 ‫werde eine Umgebungsvariable erstellen, die 19 00:01:00,350 --> 00:01:02,320 ‫dieses Kennwort enthält. 20 00:01:02,320 --> 00:01:06,100 ‫Da es immer das Gleiche ist, sollte das kein Problem sein. 21 00:01:06,100 --> 00:01:07,833 ‫Denken Sie also daran, wie wir das tun. 22 00:01:09,920 --> 00:01:12,730 ‫Nun, wir kommen hier zum Umweltmanagement 23 00:01:13,970 --> 00:01:16,903 ‫und fügen hier einfach noch einen hinzu. 24 00:01:17,960 --> 00:01:19,807 ‫Also Passwort test1234. 25 00:01:23,820 --> 00:01:28,820 ‫Und hier ist dies nicht korrekt, also Passwort aktualisiert, und jetzt machen 26 00:01:30,220 --> 00:01:31,860 ‫wir dasselbe auch hier 27 00:01:31,860 --> 00:01:33,363 ‫in der Produktion. 28 00:01:35,440 --> 00:01:37,297 ‫Also Passwort test1234. 29 00:01:41,020 --> 00:01:46,020 ‫Also, nicht hinzufügen, aber schließen wir das und so 30 00:01:46,590 --> 00:01:51,120 ‫kann ich das jetzt hinzufügen und verwenden, 31 00:01:51,120 --> 00:01:55,003 ‫nicht in einem String, sondern so. 32 00:01:56,840 --> 00:01:58,490 ‫Also Passwort. 33 00:01:58,490 --> 00:01:59,633 ‫Versuchen wir es also. 34 00:02:00,980 --> 00:02:04,620 ‫Und das gibt uns diesen seltsamen Fehler, 35 00:02:04,620 --> 00:02:07,840 ‫aber unser Passwort ist tatsächlich hier, 36 00:02:07,840 --> 00:02:12,313 ‫also müssen wir wahrscheinlich wirklich die Anführungszeichen hier einfügen. 37 00:02:13,360 --> 00:02:14,680 ‫Versuchen wir es also. 38 00:02:14,680 --> 00:02:17,740 ‫Und so sind wir nun tatsächlich erfolgreich eingeloggt. 39 00:02:17,740 --> 00:02:21,090 ‫Also spar dir das jetzt, okay? 40 00:02:21,090 --> 00:02:23,990 ‫Was wir jetzt also tun sollten, ist, für jede 41 00:02:23,990 --> 00:02:26,290 ‫einzelne Anfrage, die wir in unserer Sammlung 42 00:02:26,290 --> 00:02:28,150 ‫haben, eine Beschreibung zu erstellen. 43 00:02:28,150 --> 00:02:30,120 ‫Das werde ich jetzt natürlich nicht 44 00:02:30,120 --> 00:02:33,173 ‫tun, ich werde es hier nur mit dem ersten veranschaulichen. 45 00:02:34,270 --> 00:02:35,103 ‫Okay? 46 00:02:36,630 --> 00:02:39,250 ‫Also lassen Sie uns diese anderen 47 00:02:39,250 --> 00:02:42,840 ‫tatsächlich schließen und jetzt können wir hier eine Beschreibung hinzufügen. 48 00:02:42,840 --> 00:02:46,350 ‫Sagen wir einfach, verwenden Sie diesen Endpunkt, 49 00:02:49,150 --> 00:02:52,403 ‫um eine neue Tour zu erstellen. 50 00:02:53,530 --> 00:02:58,514 ‫Okay, und Sie sollten jetzt genau dasselbe für alle Ihre Anfragen 51 00:02:58,514 --> 00:03:03,030 ‫tun, wenn Ihr Ziel darin besteht, Ihre API wirklich 52 00:03:03,030 --> 00:03:06,170 ‫zu veröffentlichen und zu teilen, okay? 53 00:03:06,170 --> 00:03:09,633 ‫Dann gilt das gleiche für Ordner, und zwar 54 00:03:11,130 --> 00:03:14,300 ‫nicht zum Umbenennen, sondern zum Bearbeiten. 55 00:03:14,300 --> 00:03:15,900 ‫Und so können wir 56 00:03:15,900 --> 00:03:18,870 ‫in jedem dieser Ordner eigentlich auch eine Beschreibung hinzufügen. 57 00:03:18,870 --> 00:03:23,380 ‫Sagen wir einfach etwas Zufälliges wie, Sie 58 00:03:23,380 --> 00:03:27,093 ‫können alle Touren abrufen, neue 59 00:03:27,960 --> 00:03:29,463 ‫erstellen 60 00:03:31,400 --> 00:03:34,743 ‫und Touren bearbeiten und löschen. 61 00:03:36,580 --> 00:03:41,000 ‫Für einige spezielle Anforderungen gibt es auch 62 00:03:42,630 --> 00:03:44,763 ‫spezielle Endpunkte. 63 00:03:46,170 --> 00:03:48,680 ‫Okay, also das ist immer wieder total 64 00:03:48,680 --> 00:03:52,350 ‫zufällig und ich würde so etwas für meine eigene API veröffentlichen, 65 00:03:52,350 --> 00:03:56,100 ‫aber hier wollen wir wirklich nur testen, wie es funktioniert, okay? 66 00:03:56,100 --> 00:03:57,540 ‫Wie Sie hier unten 67 00:03:57,540 --> 00:04:00,800 ‫sehen können, können Sie auch Mark hier unten verwenden, okay? 68 00:04:00,800 --> 00:04:03,240 ‫Um zum Beispiel Text fett zu 69 00:04:03,240 --> 00:04:06,273 ‫machen, können Sie denken, dass es so funktioniert, ja, 70 00:04:07,820 --> 00:04:09,920 ‫es sieht so aus, und 71 00:04:09,920 --> 00:04:13,523 ‫ja, ja, Sie können hier alle möglichen Dinge tun, okay? 72 00:04:15,970 --> 00:04:18,730 ‫Sie können wahrscheinlich 73 00:04:18,730 --> 00:04:21,500 ‫auch eine Beschreibung zu 74 00:04:21,500 --> 00:04:26,363 ‫Natours selbst erstellen. Nehmen wir an, die 75 00:04:30,950 --> 00:04:35,950 ‫Natours-API enthält Endpunkte für Touren, Benutzer und Bewertungen. 76 00:04:37,790 --> 00:04:39,510 ‫Und dann wieder eine 77 00:04:39,510 --> 00:04:42,500 ‫Menge Zeug, wie Sie Ihren Authentifizierungsprozess oder Ihre 78 00:04:42,500 --> 00:04:45,320 ‫Berechtigungen beschreiben könnten und wirklich alles, was 79 00:04:45,320 --> 00:04:48,820 ‫der Benutzer wissen muss, um diese API zu verwenden, okay? 80 00:04:48,820 --> 00:04:50,510 ‫Sie sollten also 81 00:04:50,510 --> 00:04:54,060 ‫immer zu allen Anfragen, zu allen Ordnern und 82 00:04:54,060 --> 00:04:57,490 ‫natürlich auch zur Sammlung selbst eine Beschreibung hinzufügen. 83 00:04:57,490 --> 00:05:01,510 ‫Oh, und wir können die Abfrageparameter tatsächlich in einer Abfragezeichenfolge beschreiben, also 84 00:05:01,510 --> 00:05:03,943 ‫lassen Sie uns das hier tun. 85 00:05:09,634 --> 00:05:13,384 ‫Und wir können auch sagen, dass es größer 86 00:05:14,620 --> 00:05:19,620 ‫als, kleiner als gleich, größer als und kleiner als Operatoren unterstützt. 87 00:05:23,070 --> 00:05:24,890 ‫Also noch einmal hier nur ein 88 00:05:26,070 --> 00:05:28,490 ‫Beispiel und speichern wir es jetzt in der Anfrage ab. 89 00:05:28,490 --> 00:05:30,580 ‫Und damit denke ich, sollten 90 00:05:30,580 --> 00:05:33,700 ‫wir bereit sein, unsere API-Dokumentation tatsächlich zu veröffentlichen. 91 00:05:33,700 --> 00:05:36,750 ‫Um das zu tun, gehen wir 92 00:05:36,750 --> 00:05:39,910 ‫einfach hier zur Option Sammlungen und veröffentlichen 93 00:05:39,910 --> 00:05:42,070 ‫dann hier unten Dokumentationen. 94 00:05:42,070 --> 00:05:45,400 ‫Und so sollte sich dann ein Browserfenster öffnen, und bei 95 00:05:45,400 --> 00:05:47,830 ‫mir geschah es außerhalb meines Bildschirms, 96 00:05:47,830 --> 00:05:50,570 ‫also lassen Sie mich das einfach hierher bringen. 97 00:05:50,570 --> 00:05:53,700 ‫Und so können Sie jetzt die Umgebung auswählen. 98 00:05:53,700 --> 00:05:57,200 ‫Hier sollten wir also eine Liste unserer Umgebungen haben, 99 00:05:57,200 --> 00:06:01,470 ‫die wir aus irgendeinem Grund nicht haben, das ist seltsam, aber 100 00:06:01,470 --> 00:06:05,060 ‫wir wollten sowieso keine Umgebung verwenden, weil das dann 101 00:06:05,060 --> 00:06:06,540 ‫unsere Umgebungsvariablen durch ihre 102 00:06:06,540 --> 00:06:09,340 ‫echten Werte ersetzen würde, und das wollen 103 00:06:09,340 --> 00:06:10,460 ‫wir nicht. 104 00:06:10,460 --> 00:06:12,620 ‫Zum Beispiel haben wir die Umgebungsvariable 105 00:06:12,620 --> 00:06:14,620 ‫für das Passwort verwendet, damit 106 00:06:14,620 --> 00:06:17,900 ‫sie später in der Dokumentation nicht wirklich sichtbar ist, okay? 107 00:06:17,900 --> 00:06:20,313 ‫Wir wollen also wirklich keine Umgebung nutzen. 108 00:06:21,270 --> 00:06:23,280 ‫Jetzt könnten wir auch eine 109 00:06:23,280 --> 00:06:27,610 ‫benutzerdefinierte Domain verwenden, aber das ist nur für zahlende Benutzer, okay? 110 00:06:27,610 --> 00:06:30,740 ‫Dann könnten wir auch das gesamte Styling der 111 00:06:30,740 --> 00:06:34,410 ‫API ändern, um es an Ihre Markenfarben anzupassen, aber auch 112 00:06:34,410 --> 00:06:37,260 ‫das ist in diesem Fall nicht 113 00:06:37,260 --> 00:06:40,620 ‫notwendig, also lassen Sie uns es tatsächlich veröffentlichen. 114 00:06:40,620 --> 00:06:42,550 ‫Dies ist nun tatsächlich öffentlich, 115 00:06:42,550 --> 00:06:46,367 ‫sodass jeder Ihre Dokumentation jetzt unter dieser URL anzeigen kann. 116 00:06:47,480 --> 00:06:51,300 ‫Aus irgendeinem Grund wurden nicht alle Änderungen aktualisiert, die wir zuvor 117 00:06:51,300 --> 00:06:54,653 ‫vorgenommen haben, also ist das ein bisschen seltsam. 118 00:06:55,510 --> 00:06:58,420 ‫Gehen wir also zurück zu Postman und 119 00:06:58,420 --> 00:07:00,090 ‫sehen, was los ist. 120 00:07:00,090 --> 00:07:04,510 ‫Vielleicht hat es mit diesem rotierenden Ding hier zu tun, also werde ich 121 00:07:04,510 --> 00:07:07,158 ‫Postman einfach beenden und es wieder öffnen. 122 00:07:07,158 --> 00:07:09,393 ‫Und hoffen wir, dass es damit behoben ist. 123 00:07:12,610 --> 00:07:15,060 ‫Also wenn wir jetzt hier neu 124 00:07:15,060 --> 00:07:18,720 ‫laden, ahh dann bekommen wir eigentlich alle unsere Änderungen hier. 125 00:07:18,720 --> 00:07:20,980 ‫Sie sehen also die Beschreibung, 126 00:07:20,980 --> 00:07:23,620 ‫die wir für die Natours-Kollektion hinzugefügt haben, okay? 127 00:07:23,620 --> 00:07:26,830 ‫Dann auch die Beschreibung für diesen Ordner und 128 00:07:26,830 --> 00:07:29,530 ‫die Beschreibung für diese Anfrage. 129 00:07:29,530 --> 00:07:32,180 ‫Und zum Schluss als 130 00:07:32,180 --> 00:07:35,400 ‫erste Beschreibung auch für diesen Parameter, okay? 131 00:07:35,400 --> 00:07:39,477 ‫Hier erhalten wir dann die URL-Umgebungsvariable anstelle 132 00:07:39,477 --> 00:07:41,850 ‫der eigentlichen URL. 133 00:07:41,850 --> 00:07:44,310 ‫Nun möchten Sie natürlich hier die 134 00:07:44,310 --> 00:07:46,320 ‫echte URL angeben und 135 00:07:46,320 --> 00:07:48,443 ‫dafür einfach eine andere Umgebung verwenden. 136 00:07:50,150 --> 00:07:53,170 ‫Hier oben können Sie also tatsächlich alle Umgebungen 137 00:07:53,170 --> 00:07:57,060 ‫sehen, aber sie sind privat, also kann sie im Moment niemand 138 00:07:57,060 --> 00:07:58,720 ‫benutzen, aber denken 139 00:07:58,720 --> 00:08:01,430 ‫Sie daran, dass wir im ersten Schritt 140 00:08:01,430 --> 00:08:04,760 ‫diese Dokumentation tatsächlich mit einer der Umgebungen hätten erstellen 141 00:08:04,760 --> 00:08:07,990 ‫können, und wahrscheinlich würden wir das tun haben 142 00:08:07,990 --> 00:08:11,350 ‫die Produktionsumgebung dafür verwendet und damit hätten wir dann 143 00:08:11,350 --> 00:08:14,543 ‫die endgültige Produktions-URL hier in unseren API-URLs, okay? 144 00:08:15,440 --> 00:08:18,064 ‫Jedenfalls sieht die Dokumentation so 145 00:08:18,064 --> 00:08:21,530 ‫aus, also hier die Beispielanfrage und wir können 146 00:08:21,530 --> 00:08:24,940 ‫das auch in unsere eigene Sprache ändern. 147 00:08:24,940 --> 00:08:27,840 ‫In diesem Fall also Node JS, 148 00:08:27,840 --> 00:08:31,020 ‫aber wenn der Benutzer beispielsweise eine Anfrage 149 00:08:31,020 --> 00:08:34,770 ‫mit jQuery durchführt, kann er einfach jQuery verwenden, okay. 150 00:08:34,770 --> 00:08:39,290 ‫Also nur um diese Beispielanfrage hier zu sehen, mit Node sieht es 151 00:08:39,290 --> 00:08:40,793 ‫ungefähr so aus. 152 00:08:42,870 --> 00:08:45,213 ‫Hier haben wir also alle 153 00:08:45,213 --> 00:08:48,400 ‫unsere Endpunkte und Sie können sehen, dass diejenigen, die 154 00:08:48,400 --> 00:08:51,400 ‫eine Authentifizierung erfordern, tatsächlich dieses Schlosssymbol hier haben. 155 00:08:51,400 --> 00:08:54,299 ‫Und so könnten Sie in Ihrer Beschreibung nun 156 00:08:54,299 --> 00:08:57,960 ‫den Spruch hinzufügen, dass Sie sich anmelden müssen, um auf diesen Endpunkt 157 00:08:57,960 --> 00:09:01,060 ‫zuzugreifen, und auch, wie Sie sich tatsächlich anmelden können, okay. 158 00:09:01,060 --> 00:09:02,760 ‫Oder Sie können 159 00:09:02,760 --> 00:09:06,290 ‫das auch hier im Abschnitt Authentifizierung beschreiben, oder? 160 00:09:06,290 --> 00:09:09,243 ‫Idealerweise haben Sie also Beschreibungen für all dies. 161 00:09:10,360 --> 00:09:11,948 ‫Oh, und hier sehe 162 00:09:11,948 --> 00:09:15,770 ‫ich, dass wir tatsächlich vergessen haben, das echte Passwort zu 163 00:09:15,770 --> 00:09:19,940 ‫ersetzen, aber egal, da dies wirklich nur ein Beispiel ist, okay? 164 00:09:19,940 --> 00:09:22,040 ‫Aber natürlich bekommen Sie auch 165 00:09:22,040 --> 00:09:24,933 ‫hier alle Anfragen, die wir in unserem Postboten hatten. 166 00:09:26,900 --> 00:09:30,780 ‫Ein weiteres nettes Feature hier ist diese Run in 167 00:09:30,780 --> 00:09:33,830 ‫Postman-Schaltfläche. Wenn also jemand Postman auf seinem 168 00:09:33,830 --> 00:09:36,380 ‫Computer installiert hat, muss er 169 00:09:36,380 --> 00:09:40,000 ‫nur hier klicken und dann mit seiner Postman-Anwendung öffnen. 170 00:09:40,000 --> 00:09:42,490 ‫Das mache ich jetzt jetzt nicht, 171 00:09:42,490 --> 00:09:45,830 ‫weil ich es natürlich schon in meinem Postman habe, aber 172 00:09:45,830 --> 00:09:49,270 ‫ansonsten ist dies ein wirklich nettes Feature für die Benutzer, 173 00:09:49,270 --> 00:09:52,253 ‫um dann sofort mit Ihrer API zu experimentieren. 174 00:09:54,070 --> 00:09:57,370 ‫Okay, und ich denke, das war es eigentlich, damit 175 00:09:57,370 --> 00:09:59,330 ‫ist unser Abschnitt abgeschlossen 176 00:09:59,330 --> 00:10:02,610 ‫und unsere API ist jetzt endlich wirklich fertig. 177 00:10:02,610 --> 00:10:06,440 ‫Nochmals herzlichen Glückwunsch, dass Sie es so weit in den 178 00:10:06,440 --> 00:10:08,720 ‫Kurs geschafft haben, wir haben 179 00:10:08,720 --> 00:10:11,140 ‫hier schon so viel gemeinsam zurückgelegt. 180 00:10:11,140 --> 00:10:14,230 ‫Als nächstes steht ein sehr, sehr spannender Abschnitt 181 00:10:14,230 --> 00:10:16,460 ‫bevor, in dem wir endlich 182 00:10:16,460 --> 00:10:19,260 ‫die Benutzeroberfläche für die Natours-Website erstellen werden. 183 00:10:19,260 --> 00:10:21,510 ‫Im Grunde werden wir also Vorlagen 184 00:10:21,510 --> 00:10:24,770 ‫verwenden, um eine vollständig dynamische Website basierend auf allen Daten 185 00:10:24,770 --> 00:10:27,810 ‫zu erstellen, die wir bereits in unserer Datenbank haben. 186 00:10:27,810 --> 00:10:29,380 ‫Und das ist wirklich cool. 187 00:10:29,380 --> 00:10:32,053 ‫Und so kann ich es kaum erwarten, Ihnen das zu zeigen.