Zarządzaj specyfikacjami

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Apigee Edge udostępnia miejsce do przechowywania specyfikacji OpenAPI. Zarządzaj specyfikacjami OpenAPI zgodnie z opisem w sekcjach poniżej.

Więcej informacji o specyfikacjach OpenAPI znajdziesz w artykule Czym jest specyfikacja OpenAPI.

Przeglądanie listy danych technicznych

Aby uzyskać dostęp do listy specyfikacji:

1. Zaloguj się na apigee.com/edge.
2. Wybierz organizację.
3. W menu nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.

Wyświetli się bieżąca lista specyfikacji i folderów.

Jak widać na poprzednim rysunku, na liście specyfikacji możesz:

• Tworzenie i importowanie specyfikacji
• Generowanie serwera proxy interfejsu API na podstawie specyfikacji za pomocą wieloetapowego kreatora
• porządkować specyfikacje za pomocą folderów i przeglądać te foldery (patrz Porządkowanie treści za pomocą folderów);
• Edytowanie specyfikacji lub otwieranie folderu przez kliknięcie wiersza
• Zmienianie nazwy lub usuwanie specyfikacji
• Przeszukiwanie listy specyfikacji i folderów

Tworzenie nowej specyfikacji OpenAPI

Aby utworzyć nową specyfikację OpenAPI:

1. Na pasku nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. Kliknij + Specyfikacja.
3. W menu kliknij Nowa specyfikacja. Otworzy się edytor specyfikacji.
4. Zastąp przykładową specyfikację szczegółami własnej specyfikacji OpenAPI.
   Zobacz Tworzenie specyfikacji za pomocą edytora specyfikacji.
5. Aby zapisać specyfikację, kliknij Zapisz.
6. Gdy pojawi się odpowiedni komunikat, wpisz nazwę specyfikacji.
7. Kliknij Zapisz.

Importowanie specyfikacji OpenAPI

Aby zaimportować specyfikację OpenAPI:

1. Na pasku nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. Kliknij + Specyfikacja.
3. W menu kliknij jedną z tych opcji:
   • Importuj adres URL, aby zaimportować specyfikację z adresu URL. Gdy pojawi się prośba, podaj nazwę i adres URL.
   • Kliknij Importuj plik, aby przejrzeć katalog lokalny w poszukiwaniu specyfikacji.
     Specyfikacja zostanie dodana do listy.
4. Kliknij nazwę specyfikacji, aby wyświetlić ją i edytować w edytorze specyfikacji.
   Zobacz Tworzenie specyfikacji za pomocą edytora specyfikacji.

Edytowanie istniejącej specyfikacji OpenAPI

Aby otworzyć istniejącą specyfikację OpenAPI:

1. Na pasku nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. Na liście specyfikacji kliknij wiersz powiązany ze specyfikacją.
3. Edytuj specyfikację w edytorze specyfikacji.
   Zobacz Tworzenie specyfikacji za pomocą edytora specyfikacji.

Tworzenie serwera proxy interfejsu API na podstawie specyfikacji na liście specyfikacji

Apigee Edge umożliwia tworzenie serwerów proxy interfejsu API na podstawie specyfikacji OpenAPI, które projektujesz i zapisujesz w edytorze specyfikacji. Wystarczy kilka kliknięć, aby w Apigee Edge utworzyć proxy interfejsu API z automatycznie wygenerowanymi ścieżkami, parametrami, przepływami warunkowymi i docelowymi punktami końcowymi. Następnie możesz dodać funkcje takie jak zabezpieczenia OAuth, ograniczenia liczby żądań i pamięć podręczna.

Jeśli po utworzeniu proxy interfejsu API na podstawie specyfikacji OpenAPI specyfikacja zostanie zmodyfikowana, musisz ręcznie zmodyfikować proxy interfejsu API, aby odzwierciedlić wprowadzone zmiany. Zobacz Co się stanie, jeśli zmodyfikuję specyfikację?.

Aby utworzyć proxy interfejsu API na podstawie specyfikacji OpenAPI na liście specyfikacji:

1. W menu nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. W razie potrzeby otwórz folder zawierający specyfikację OpenAPI.
3. Umieść kursor na specyfikacji OpenAPI, dla której chcesz utworzyć proxy interfejsu API, aby wyświetlić menu działań.
4. Kliknij . Otworzy się kreator tworzenia proxy, a strona z informacjami o proxy zostanie wstępnie wypełniona wartościami ze specyfikacji OpenAPI, jak pokazano na ilustracji poniżej.
   
5. Kliknij Dalej.
6. Przejdź przez pozostałe strony kreatora tworzenia proxy zgodnie z opisem w artykule Tworzenie proxy interfejsu API na podstawie specyfikacji OpenAPI. (Zacznij od kroku 8).

Zmienianie nazwy specyfikacji

Aby zmienić nazwę specyfikacji:

1. W menu nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. W razie potrzeby otwórz folder zawierający specyfikację.
3. Umieść kursor nad specyfikacją, której nazwę chcesz zmienić, aby wyświetlić menu działań.
4. Kliknij .
5. Zmień nazwę specyfikacji.
6. Aby zapisać zmiany, kliknij Zmień nazwę, a aby je anulować – Anuluj.

Przenoszenie specyfikacji do folderu

Specyfikacje możesz uporządkować w folderach, aby ułatwić zarządzanie nimi i zwiększyć bezpieczeństwo. Aby przenieść specyfikację do folderu, przeczytaj artykuł Porządkowanie specyfikacji za pomocą folderów.

Usuwanie specyfikacji

Możesz usunąć specyfikację z magazynu plików, gdy nie jest już potrzebna lub stanie się nieprawidłowa.

Aby usunąć specyfikację:

1. W menu nawigacyjnym po lewej stronie kliknij Tworzenie > Specyfikacje.
2. Umieść kursor nad specyfikacją, którą chcesz usunąć, aby wyświetlić menu działań.
3. Kliknij .
4. W oknie wiersza poleceń kliknij Usuń, aby potwierdzić usunięcie.
5. Usuń powiązane artefakty, które nie są już potrzebne.