Zarządzaj specyfikacjami

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Apigee Edge udostępnia miejsce na przechowywanie specyfikacji OpenAPI. Zarządzaj specyfikacjami OpenAPI w sposób opisany w kolejnych sekcjach.

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

Zobacz listę specyfikacji

Aby uzyskać dostęp do listy specyfikacji:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Wybierz organizację.
  3. W bocznym menu nawigacyjnym wybierz Programowanie > Specyfikacje.

Zostanie wyświetlona bieżąca lista specyfikacji i folderów.

Lista specyfikacji

Jak zaznaczyliśmy na poprzedniej ilustracji, na liście specyfikacji możesz:

Utwórz nową specyfikację OpenAPI

Aby utworzyć nową specyfikację OpenAPI:

  1. Na bocznym pasku nawigacyjnym kliknij Programowanie > Specyfikacje.
  2. Kliknij + Specyfikacja.
  3. W menu kliknij Nowa specyfikacja. Otworzy się edytor specyfikacji.
  4. Zastąp przykładową specyfikację własnymi szczegółami specyfikacji OpenAPI.
    Przeczytaj artykuł Tworzenie specyfikacji w edytorze specyfikacji.
  5. Kliknij Zapisz, aby zapisać specyfikację.
  6. Gdy pojawi się prośba, wpisz nazwę specyfikacji.
  7. Kliknij Zapisz.

Importowanie specyfikacji OpenAPI

Aby zaimportować specyfikację OpenAPI:

  1. Na bocznym pasku nawigacyjnym kliknij Programowanie > Specyfikacje.
  2. Kliknij + Specyfikacja.
  3. Kliknij w menu jedną z tych opcji:
    • Importuj adres URL, aby zaimportować specyfikację z adresu URL. Gdy pojawi się prośba, podaj nazwę i adres URL.
    • Importuj plik, aby przeglądać katalog lokalny w poszukiwaniu specyfikacji.
      Specyfikacja zostanie dodana do listy.
  4. Kliknij nazwę specyfikacji, aby ją wyświetlić i edytować w edytorze specyfikacji.
    Przeczytaj artykuł na temat tworzenia specyfikacji za pomocą edytora specyfikacji.

Edytowanie istniejącej specyfikacji OpenAPI

Aby otworzyć istniejącą specyfikację OpenAPI:

  1. Na bocznym pasku nawigacyjnym kliknij Programowanie > Specyfikacje.
  2. Na liście specyfikacji kliknij wiersz powiązany ze specyfikacją.
  3. Edytuj specyfikację w edytorze specyfikacji.
    Przeczytaj artykuł Tworzenie specyfikacji w edytorze specyfikacji.

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

W Apigee Edge możesz tworzyć serwery proxy interfejsów API na podstawie specyfikacji OpenAPI, które możesz projektować i zapisywać w edytorze specyfikacji. Wystarczy kilka kliknięć, aby utworzyć w Apigee Edge serwer proxy interfejsu API ze ścieżkami, parametrami, przepływami warunkowymi i docelowymi punktami końcowymi wygenerowanymi automatycznie. Następnie możesz dodać funkcje takie jak zabezpieczenia OAuth, ograniczanie liczby żądań i pamięć podręczna.

Jeśli po utworzeniu serwera proxy interfejsu API na podstawie specyfikacji OpenAPI specyfikacja ulegnie zmianie, konieczne będzie ręczne zmodyfikowanie serwera proxy interfejsu API w celu odzwierciedlenia wprowadzonych zmian. Przeczytaj artykuł Co się stanie, jeśli zmodyfikuję specyfikację?.

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

  1. W bocznym menu nawigacyjnym wybierz Programowanie > Specyfikacje.
  2. W razie potrzeby przejdź do folderu zawierającego specyfikację OpenAPI.
  3. Ustaw kursor na specyfikacji OpenAPI, dla której chcesz utworzyć serwer proxy interfejsu API, aby wyświetlić menu czynności.
  4. Kliknij wygeneruj serwer proxy. Zostanie otwarty kreator tworzenia serwera proxy, a strona Szczegóły serwera proxy jest wstępnie wypełniona wartościami ze specyfikacji OpenAPI, jak pokazano na tej ilustracji.
    utwórz kreatora serwera proxy
  5. Kliknij Dalej.
  6. Przejdź przez pozostałe strony w kreatorze tworzenia serwera proxy zgodnie z opisem w sekcji Tworzenie serwera proxy interfejsu API ze specyfikacji OpenAPI. (Zacznij od kroku 8).

Zmiana nazwy specyfikacji

Aby zmienić nazwę specyfikacji:

  1. W bocznym menu nawigacyjnym wybierz Programowanie > Specyfikacje.
  2. W razie potrzeby przejdź do folderu zawierającego specyfikację.
  3. Najedź kursorem na specyfikację, której nazwę chcesz zmienić, aby wyświetlić menu czynności.
  4. Kliknij Zmień nazwę specyfikacji.
  5. Zmień nazwę specyfikacji.
  6. Kliknij Zmień nazwę, aby zapisać zmiany, lub Anuluj, aby anulować.

Przenoszenie specyfikacji do folderu

Możesz uporządkować specyfikacje w foldery, aby ułatwić zarządzanie i bezpieczeństwo. Aby dowiedzieć się, jak przenieść specyfikację do folderu, przeczytaj sekcję 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 bocznym menu nawigacyjnym wybierz Programowanie > Specyfikacje.
  2. Najedź kursorem na specyfikację, którą chcesz usunąć, aby wyświetlić menu czynności.
  3. Kliknij Ikona usuwania.
  4. Kliknij Usuń, aby potwierdzić operację usuwania po wyświetleniu się komunikatu.
  5. Usuń powiązane artefakty, które nie są już potrzebne.