Ok, na ekranie
mam konto GitHub dla specyfikacji OpenAPI.
Jest to więc miejsce, w którym znajduje się cały kod źródłowy OpenAPI.
Znajduje się on w tym repozytorium GitHub.
Link do niego podam w zasobach kursu, więc możesz przejść tutaj.
Jest teraz kilka rzeczy, na które chciałbym zwrócić uwagę, szczególnie w przypadku
kursu, któremu będziemy się przyglądać. Jeśli wejdziesz tutaj i spojrzysz na katalog przykładów w GitHub, zobaczysz,
że mamy wersję 2. 0 i 3. 0.
Ponownie nie skupiam się na 2. 0, ale będę patrzył na 3. 0.
Oto kilka różnych przykładów.
Pamiętaj, że patrzyliśmy na petstore, więc oto petstore. YAML posiada specyfikację OpenAPI.
Widać, że istnieje kilka różnych implementacji specyfikacji OpenAPI, którym możemy się przyjrzeć.
Tak więc kilka naprawdę dobrych przykładów, gdy chcesz zobaczyć, jak coś
zrobić, możesz przejrzeć i przejrzeć te i wróćmy tutaj. Następną rzeczą, której chcemy się przyjrzeć, jest
ten plik IMPLEMENTATIONS tutaj. Są to znane implementacje dla OpenAPI3. 0.
Widzimy, że istnieje wiele narzędzi, które zostały skonfigurowane w różnych dostępnych programach.
Ta lista stale się powiększa. Gorąco polecam przyjrzenie się temu i dostępne są
różne technologie.
Jestem głównie programistą Java, więc można tam zobaczyć wiele narzędzi Java.
Ledwo potrafię przeliterować Ruby, ale są tam narzędzia Ruby, Node. js, Typescript, PHP. Mamy więc do dyspozycji dużą
liczbę narzędzi.
Pamiętaj, że powiedziałem, że będziemy używać edytora SwaggerHub.
Oto kilka konkretnych narzędzi do pracy z OpenAPI.
Niektórzy konkretni redaktorzy. Wiele osób lubi Visual Studio.
W rzeczywistości użyłem tego tutaj na górze Rozszerzenie Visual Studio Code jest całkiem fajne. Możesz więc preferować korzystanie z
Sisual Studio.
Jest to darmowe narzędzie, z którego można korzystać.
W rzeczywistości wiem o niektórych, które nie są tutaj dostępne, więc nie jest to w żadnym wypadku pełna lista, w rzeczywistości
istnieją dodatkowe narzędzia, których nie ma na tej liście.
Następnie możesz zobaczyć tutaj Interfejsy użytkownika.
Są to więc narzędzia, które uwzględnimy w specyfikacji OpenAPI i udostępnimy dokumentację.
Widzieliśmy już więc swagger-ui w akcji.
A oto kilka dodatkowych opcji.
Tak więc Widdershins jest dość popularny.
Jeśli chodzi o generowanie dokumentacji użytkownika końcowego na podstawie specyfikacji OpenAPI, osobiście bardzo lubię
Redoc.
Jest to bardzo przyjemne narzędzie do generowania dokumentacji użytkownika na podstawie specyfikacji OpenAPI, a teraz
możesz również zobaczyć, że mamy implementacje serwera, implementacje klienta, generatory kodu.
Istnieje więc wiele różnych generatorów kodu, które można wykorzystać ze specyfikacją OpenAPI.
Przenieśmy to z powrotem tutaj.
I pamiętaj, że powiedziałem, że specyfikacja OpenAPI jest poparta formalnym schematem.
Poniżej znajduje się schemat JSON.
Jeśli chcesz przejrzeć i zobaczyć dokładnie,
tutaj możesz naprawdę przyjrzeć się, jak zdefiniowany jest schemat OpenAPI, jest to surowy kod źródłowy, że tak powiem,
ale przyjrzymy się temu w inny sposób. Nie będę się zbytnio zagłębiał
w ten temat, ale wrócę tutaj i na koniec gorąco polecam przejrzenie tej dokumentacji,
która jest bardzo obszerna.
Możesz zobaczyć narzędzia i biblioteki, jak to jest licencjonowane, jeśli chcesz przyczynić się do tego projektu,
jest to projekt open source.
Tak więc mają nawet techniczny komitet sterujący opracowujący wytyczne, więc oczywiście nie będę tutaj
omawiał każdej rzeczy, o której mówimy, próbując dostać się do OpenAPI i możesz zobaczyć tutaj,
że obecnie jesteśmy na 3. 0. 2.
A jeśli kliknę na to, ten link przeniesie mnie do dwóch wersji.
Więc po prostu pójdę dalej i kliknę na to.
Jest to dokumentacja schematu OpenAPI, z którą bardzo dokładnie się zapoznamy.
W szczególności przyjrzymy się programowaniu w oparciu o schemat OpenAPI
i przyjrzymy się konkretnemu obiektowi OpenAPI. Jak widać, jest to specyfikacja schematu najwyższego poziomu,
którą będziemy omawiać w kolejnych filmach.
Dokumentacja OpenAPI jest bardzo bogata, bardzo szczegółowa i należy ją traktować
jako jedyne źródło prawdy podczas pracy z dokumentacją OpenAPI.