Wykorzystanie SmartSmart do dokumentowania interfejsów API

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

.

SmartDokumenty umożliwiają dokumentowanie interfejsów API w portalu dla deweloperów Drupal 7 w sposób, który sprawia, Dokumentacja interfejsu API jest w pełni interaktywna. Interaktywna dokumentacja oznacza, że użytkownicy portalu mogą:

  • Poczytaj o interfejsach API
  • Wyślij aktywne żądanie do interfejsu API
  • Wyświetlanie odpowiedzi na żywo zwróconej przez interfejs API

Tworząc interaktywną dokumentację interfejsów API, ułatwiasz użytkownikowi portalu do poznawania, testowania i oceniania interfejsów API.

Edge Management API to interfejs API typu REST, który umożliwia dostęp do usług API za pomocą klienta HTTP. Apigee używa SmartDocuments do tworzenia interaktywnej dokumentacji zarządzania brzegiem API. Dokumentację interfejsu API znajdziesz tutaj.

Przykład portalu SmartDocuments

Aby korzystać z Dokumentów SmartDocuments, musisz mieć portal usług dla deweloperów Apigee. Więcej informacji: Tworzenie konta programisty .

Na stronie głównej portalu dla deweloperów kliknij Interfejsy API na górnym pasku nawigacyjnym, aby Wyświetl stronę dokumentacji interfejsu API.

W portalu są udokumentowane 2 interfejsy API: Hello World i Pet Store Example.

Interfejs Hello World API został utworzony na podstawie przykładowego celu OpenAPI Specyfikacja, mocktarget.yaml. Więcej informacji znajdziesz na stronie https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.

Interfejs Pet Store Example API został utworzony na podstawie klasycznej wersji demonstracyjnej sklepu zoologicznego.

Poznaj interfejs Hello World API:

  1. Kliknij Hello World API. Zostanie wyświetlona strona podsumowania interfejsu Hello World API:
  2. Kliknij Wyświetl potwierdzenie interfejsu API. Dokument SmartDocuments dla tego zasobu to wyświetlono:
  3. Kliknij Wyślij tę prośbę.
  4. Wyświetl zwróconą odpowiedź: 
    HTTP/1.1 200 OK
Connection:
keep-alive
Content-Length:
18
Content-Type:
text/html; charset=utf-8
Date:
Tue, 21 Jun 2016 21:49:32 GMT
ETag:
W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
X-Powered-By:
Apigee
<H2>I <3 APIs</H2>
  5. Kliknij kartę Prośba, aby wyświetlić prośbę, lub kliknij cURL. Tab, aby wyświetlić odpowiednie wywołanie cURL.

Jak dokumentować interfejsy API za pomocą SmartDocuments

Obiekty SmartDokumenty przedstawiają interfejsy API za pomocą modelu, w którym model zawiera wszystkie o interfejsach API w Twojej firmie. Portal wyodrębnia informacje o interfejsach API z modelu do: wyrenderować strony dokumentacji w portalu jako węzły Drupala, których każdy węzeł odpowiada otwiera stronę z dokumentacją w portalu.

Ogólne czynności, które należy wykonać, aby korzystać z Dokumentów SmartDokumentów:

  1. Skonfiguruj w portalu moduł SmartDocuments Drupal.
  2. Utwórz model Dokumentów.
  3. Dodaj interfejsy API do modelu z pliku WADL, OpenAPI (dawniej Swagger). lub ręcznie.
  4. Wyrenderuj model jako zbiór węzłów Drupala. Każdy węzeł Drupala zawiera informacje na temat pojedynczego interfejsu API. Jeśli na przykład zasób w interfejsie API obsługuje zarówno POST i PUT są tworzone w osobnym węźle Drupala dla metod POST i PUT.
  5. Opublikuj węzły Drupal. Po opublikowaniu użytkownicy portalu będą mogli wyświetlać interakcji z interfejsem API.
  6. Edytuj węzły Drupal przed ich opublikowaniem lub po nich. Dostępne opcje zmodyfikować węzły Drupal przy użyciu edytora Drupal albo przez edycję oryginalnego pliku WADL lub Specyfikacja OpenAPI. Po zakończeniu edycji pliku WADL lub specyfikacji OpenAPI zaimportuj go z powrotem do modelu jako nową wersję, a następnie wyrenderuj i opublikuj zmiany.
  7. Włącz TLS. Ponieważ SmartDocuments może wysyłać dane uwierzytelniające do w ramach wysyłania żądania do interfejsów API, włącz TLS w portalu, upewnij się, że są one bezpieczne. W środowiskach produkcyjnych i testowych portalu Apigee udostępnia certyfikat TLS wymagany do wysyłania żądań https://. Jednak zanim to zrobisz, aby działać w portalu, musisz uzyskać własny certyfikat TLS i włączyć TLS. Więcej informacji: Używanie protokołu TLS w .

Informacje o modelach i szablonach SmartDoc

Gdy utworzysz model w portalu, będzie on przechowywany w Edge organizacji, a nie Drupala. Model to duży blok JSON o nazwie wewnętrznej (takiej jak „my-smartdocs-api”) i definiuje strukturę interfejsu API. Z drugiej strony Twój portal renderuje model w kodzie HTML i udostępnia interfejs do jego edycji. wszelkie aktualizacje interfejsu API; w portalu są automatycznie przekazywane z powrotem do modelu źródłowego.

Przechowywane w organizacji

Zapisane w Drupal

modele

szablony

Węzły Drupal z funkcją edycji

Załóżmy, że masz w organizacji wiele portali (na przykład dev, etapie produkcji). W Pantheon przenosi się portal z jednego środowiska do drugiego. Każde wystąpienie że portal zawiera własny model, ale wszystkie tak naprawdę odwołują się model atrybucji. Jeśli zmodyfikujesz interfejs API w wersji deweloperskiej, model zostanie zaktualizowany, a zmiany pojawią się w wersji produkcyjnej. Podobnie, jeśli usuniesz model w wersji deweloperskiej, źródło zostanie usunięte i nie będzie już dostępne produkcji.

Szablony kontrolują wygląd i styl Twoich Dokumentów SmartDocuments, a te szablony (zarządzane przez (sztuki kierownicy i pliki CSS) są przechowywane z każdą instancją portalu. Każdy portal można teoretycznie użyj unikalnego szablonu dla każdego modelu. Jedną z udogodnień platformy renderowania jest to, że szablon domyślny (domyślny lub podany przez Ciebie szablon) jest automatycznie zastosowane do każdego modelu.

Poniższy diagram przedstawia zależności między modelami a portalami. Zielone strzałki oznaczają, synchronizację automatyczną.

Poniższe polecenie cURL zawiera listę wszystkich modeli w organizacji:

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

Konfigurowanie modułu SmartDocuments

Platforma Apigee wdrożyła SmartDokumenty jako niestandardowy moduł Drupala. Wykonaj poniższe czynności, aby skonfigurować moduł SmartDocuments.

Aby skonfigurować moduł SmartDocuments:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. W menu administrowania Drupalem wybierz Moduły. Lista wszystkich zainstalowane moduły Drupala.
  3. Włącz moduł SmartDocs.
  4. Zapisz konfigurację.
  5. Wybierz Modules (Moduły) w menu administratora Drupala.
  6. Wybierz SmartDocuments -> Uprawnienia i zaznacz opcję „Przeprowadź administrację” w module SmartDokumenty. w polu „Administrator” jest włączona.
  7. Wybierz Konfiguracja > Portal dla programistów w administracji Drupala .
  8. Ustaw Limit czasu połączenia i Limit czasu żądania na 16 sek.
  9. Zapisz konfigurację.
  10. Skonfiguruj ustawienia adresu URL:
    1. Wybierz Konfiguracja > Wyszukiwanie i metadane > Aliasy URL > Settings (Ustawienia) w menu Drupala.
    2. Ustaw opcje Maksymalna długość aliasu i Maksymalna długość komponentu. długość na 255.
    3. Rozwiń opcję Interpunkcja.
    4. Lewy nawias klamrowy ({) i Prawy nawias klamrowy ({) (}) i wybierz Brak działania (nie zastępuj).
    5. Kliknij Save Configuration (Zapisz konfigurację).
  11. Jeśli portal dla programistów będzie widoczny dla użytkowników z sieci wewnętrznej, którzy nie mają dostępu do z internetem, a jeśli podzbiór interfejsów API znajduje się w sieci prywatnej, skonfiguruj interfejs SmartDocuments API. URL serwera proxy:
    1. Wybierz Konfiguracja > SmartDocuments w administracji Drupala .
    2. Rozwiń Ustawienia zaawansowane.
    3. Zaktualizuj pole URL serwera proxy SmartDocuments w ten sposób: <host>/smartdocs/v1/sendrequest
      Wbudowana pomoc powinna zawierać wymaganą wartość dla Twojego środowiska. Przykład:
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      Domyślna wartość w tym polu to https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest
    4. Kliknij Save Configuration (Zapisz konfigurację).

Tworzenie modelu

Model zawiera wszystkie informacje na temat reprezentacji interfejsu API. Możesz zdefiniować wiele modeli w portalu obsługujących różne interfejsy API albo zgrupuj wszystkie interfejsy API w jednym model atrybucji.

Każdy model określa unikalną nazwę wewnętrzną, która definiuje również podstawowy adres URL wygenerowanych węzłów Drupal. Adres URL każdego węzła Drupal ma postać:

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

gdzie:

  • drupalBasePath: podstawowy adres URL portalu.
  • internalName: wewnętrzna nazwa modelu.
  • httpMethod: metoda HTTP interfejsu API, np. get, put, post lub usuwania.
  • resourcePath: ścieżka zasobu.

Jeśli na przykład jako nazwę wewnętrzną podasz „mojmodel”, adres URL wygenerowanego Węzeł Drupal dla żądania GET wysłanego do zasobu o nazwie „/books” to:

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

Aby utworzyć model

Utworzony model jest przechowywany w organizacji Edge jako źródło interfejsu API do jego struktury. Więcej informacji znajdziesz w artykule Informacje o modelach SmartDoc oraz .

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > SmartDocuments w administracji Drupala .
  3. Wybierz Nowy model u góry strony.
  4. Wypełnij te pola:
    • Nazwa: nazwa modelu, która będzie wyświetlana w witrynie.
    • Nazwa wewnętrzna: podczas wpisywania nazwy tag wewnętrzny nazwa zostanie wyświetlona. Wewnętrzna nazwa modelu, która musi być niepowtarzalna wśród wszystkich modeli. Nazwa wewnętrzna może zawierać tylko małe litery, cyfry i łączniki bez spacji. Aby edytować tę nazwę, kliknij Edytuj.
    • Opis: opis modelu.
  5. Wybierz Utwórz model.

Po utworzeniu modelu nastąpi przekierowanie na jego stronę. Następnie możesz użyć z menu Operacje wybierz następujące polecenie:

  • Zaimportuj plik WADL z opisem Twojego interfejsu API lub określ adres URL OpenAPI. Specyfikacja opisująca Twój interfejs API.
  • Dodaj wersję do modelu.
  • Zmodyfikować Ustawienia modelu, w tym arkusze stylów używane przez model atrybucji.
  • Wyeksportuj model do pliku.
  • Usuń model.

Dodawanie interfejsów API do modelu

Interfejsy API możesz dodać do modelu przez:

  • Importowanie pliku WADL zawierającego definicję interfejsu API
  • Importowanie specyfikacji OpenAPI (OpenAPI 2.0 lub 1.2)
  • Ręczne tworzenie zasobów i metod

Możesz też zaimportować do modelu plik JSON SmartDocuments. Ten plik jest zwykle tworzony przez Najpierw wyeksportuj istniejący model, edytuj plik, a następnie zaimportuj aktualizacje. Aby zobaczyć więcej, Więcej informacji: Eksportowanie i importowanie modelu poniżej.

Film: obejrzyj krótki film, aby dowiedzieć się, jak dodać interfejsy API do modelu SmartDocuments importowanie specyfikacji OpenAPI.

Importowanie WADL

Po utworzeniu modelu zaimportuj plik WADL z opisem Twojego interfejsu API. Co podczas importowania pliku WADL automatycznie tworzysz nową wersję modelu.

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w Drupalu w menu administracji.
  3. Wybierz model, który chcesz zaktualizować.
  4. W sekcji Operacje kliknij Importuj.
  5. Wybierz WADL w menu Wybierz format na Strona importowania Dokumentów.
  6. Wybierz Plik lub URL w menu Prześlij Typu.
    1. Jeśli wybierzesz File (Plik), przejdź do pliku WADL.
    2. Jeśli wybierzesz URL, podaj adres URL pliku WADL.
  7. Kliknij Importuj, aby zaimportować go do modelu. Teraz możesz i wyrenderować model.
  8. Przekierujemy Cię na stronę z informacjami o modelu, na której możesz wyrenderować model atrybucji.

Importowanie interfejsu OpenAPI Specyfikacja

Po utworzeniu modelu możesz zaimportować OpenAPI (dawniej Swagger) Specyfikacja. Edge obsługuje OpenAPI w wersjach 1.2 i 2.0.

OpenAPI do opisania interfejsu API wykorzystuje pliki zawierające obiekty JSON. Za każdym razem, gdy importujesz specyfikacji OpenAPI, automatycznie utworzysz nową wersję modelu.

Aby zaimportować specyfikację OpenAPI:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w Menu administrowania Drupalem.
  3. Wybierz model, który chcesz zaktualizować.
  4. W sekcji Operacje kliknij Importuj.
  5. Wybierz Swagger JSON lub Swagger YAML Wybierz Format na stronie importowania Dokumentów Smart.
  6. Wybierz Plik lub URL w Menu Upload Type (Typ przesyłania) (w przypadku OpenAPI 1.2 musisz wybrać URL).
    1. Jeśli klikniesz File (Plik), przejdź do interfejsu OpenAPI. Specyfikacja.
    2. Jeśli wybierzesz URL, podaj adres URL OpenAPI. Specyfikacja.
  7. Kliknij Importuj, aby zaimportować go do modelu.
  8. Przekierujemy Cię na stronę z informacjami o modelu, na której możesz wyrenderować model atrybucji.

Ręczne tworzenie zasobów i metody

Jeśli nie masz pliku WADL ani specyfikacji OpenAPI reprezentującej Twój interfejs API, możesz ręcznie dodać interfejsy API do modelu. Ponadto, jeśli używasz pliku WADL lub specyfikacji OpenAPI do tworzenia swojego modelu, możesz użyć tej procedury, aby edytować interfejsy API, w tym dodać nowe, po importowanie.

Aby ręcznie dodać interfejs API:

  1. Utwórz nową wersję modelu.

    Podczas tworzenia wersji określasz jedną ścieżkę podstawową wszystkich interfejsów API w modelu co oznacza, że wszystkie interfejsy API w modelu mają tę samą ścieżkę podstawową. Na przykład podaj ścieżkę podstawową jako:

    https://myCompany.com/v1

    Gdy dodajesz zasoby do modelu, rozszerzają one ścieżkę podstawową.
  2. Zdefiniuj co najmniej 1 zasób dla modelu. Ścieżka zasobu łączy się ze ścieżką podstawową wersji modelu, aby określić pełny adres URL zasobu. Jeśli na przykład Twój zasób określa ścieżkę „/login”, pełny adres URL zasobu to:

    https://myCompany.com/v1/login
  3. Zdefiniuj co najmniej 1 metodę dla każdego zasobu. Metoda określa czasownik HTTP, którego można użyć dla zasobu. Na przykład dla parametru „/login” pozwala na logowanie się za pomocą metody POST DELETE, aby wylogować się. Ten zasób nie obsługuje innych czasowników HTTP, takich jak PUT czy GET. W związku z tym zdefiniuj 2 metody dla zasobu: jedną dla żądania POST, a drugą dla żądania DELETE.

    Metoda używa adresu URL zasobu z zasobu nadrzędnego. Dlatego wszystkie metody z tym samym Adres URL jest zdefiniowany w jednym zasobie w SmartDocuments.

Ogólna zasada:

  • Utwórz osobny model SmartDocuments dla każdej unikalnej ścieżki podstawowej w interfejsie API.
  • Zdefiniuj inny zasób SmartDocuments dla każdego unikalnego zasobu w interfejsie API.
  • Zdefiniuj inną metodę SmartDocuments dla każdego czasownika HTTP obsługiwanego przez zasób.

Tworzenie nowej wersji modelu

Zasób możesz dodać tylko do istniejącej wersji modelu. Jeśli model ma już parametr wersji, możesz dodać zasób. Jeśli model jest nowy i nie ma żadnych wersji, utwórz nowy wersji.

Aby utworzyć nową wersję modelu:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w w menu administracji Drupala.
  3. Obok modelu, który chcesz zaktualizować, wybierz Dodaj wersję. w sekcji Operacje.
  4. Na stronie Dodaj wersję interfejsu API podaj te informacje:
    • Wyświetlana nazwa: nazwa wersji wyświetlana w z portalu.
    • Identyfikator wersji: krótki identyfikator wersji.
    • Opis: opis wersji.
    • Podstawowy URL: podstawowy adres URL wszystkich interfejsów API w wersji modelu. O model może używać różnych podstawowych adresów URL dla każdej wersji. Na przykład możesz podać wersję w podstawowym adresie URL. Dla pierwszej wersji modelu podstawowy adres URL to:
      https://myCompany.com/v1
      W przypadku następnej wersji podstawowy adres URL mógłby wyglądać tak:
      https://myCompany.com/v2
  5. Wybierz Dodaj wersję. Nastąpi przekierowanie na stronę wersji modelu. Możesz teraz definiować zasoby w modelu.

Definiowanie zasobu

Zasób określa pełny adres URL interfejsu API. Definiując zasób, określasz ścieżki zasobu, która jest łączona z podstawowym adresem URL w wersji modelu w celu utworzenia pełnego adresu URL danego zasobu.

Aby zdefiniować zasób:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumentów inteligentnych w w menu administracji Drupala.
  3. Przy modelu, który chcesz zaktualizować, w sekcji Operacje wybierz opcję Interfejs API Wersje, aby wyświetlić wszystkie wersje modelu.
  4. Wybierz wersję do edycji.
  5. Na stronie wersji wybierz z menu Dodaj zasób.
  6. Na stronie Dodaj zasób podaj te informacje:
    • Wyświetlana nazwa: nazwa zasobu.
    • Ścieżka: ścieżka zasobu zaczynający się od „/”. Wartość Ścieżka jest połączona z podstawowym adresem URL wersji modelu. aby utworzyć pełny adres URL zasobu.
    • Opis: opis zasobu.
    • Parametry: opcjonalnie wpisz obiekt JSON definiujący poszczególne parametry w odniesieniu do zasobu. Opis tych parametrów znajduje się poniżej.
  7. Wybierz Dodaj zasób. Nastąpi przekierowanie na stronę modelu. Teraz możesz definiowania metod dla zasobu.

Opcjonalnie możesz dodać do zasobu parametry, takie jak szablon, zapytanie i nagłówek. . Wszystkie parametry zasobu są dziedziczone przez dowolne metody zdefiniowane dla tego zasobu. Dlatego jeśli zdefiniujesz parametr zapytania dla zasobu, wszystkie metody dodane do tego zasobu musi obsługiwać ten parametr zapytania.

Możesz również zdefiniować parametry metody. Na przykład metoda POST może obsługiwać parametrów zapytania, które nie są obsługiwane przez metodę DELETE. Dlatego wszystkie parametry w zależności od metody podczas jej definiowania, jak opisano poniżej.

Poniższy obraz przedstawia istniejącą stronę Dokumentów Smart dla domeny Interfejs Apigee Approve lub Unsubscribe Developer App API z zaznaczonym typem parametru:

Każdy typ parametru jest definiowany przez obiekt JSON:

Typ

obiekt JSON

Uwagi

Szablon

{
"dataType": "ciąg",
"defaultValue": "",
"description": "Nazwa organizacji.",
"name": "nazwa_organizacji",
"required": true,
"type": "SZABLON"
}

Parametry szablonu są zawsze wymagane, dlatego ustaw required na true i pomiń wartość jako defaultValue,

Wartość parametru description pojawia się w wyskakującym okienku, gdy użytkownik najedzie kursorem na adres URL na stronie Dokumentów Smart.

Zapytanie

{
"dataType": "ciąg",
"defaultValue": "",
"description": "Lokalizacja.",
"name": "w",
"required": true,
"type": "QUERY"
}

Wymagane parametry zapytania nadal mogą określać wartość defaultValue, ale często tego nie robią.

W przypadku opcjonalnych parametrów zapytania ustaw parametr required na false i określ wartość na defaultValue,

Nagłówek

{
"dataType": "ciąg",
"defaultValue": "application/json",
"description": "Określ jako <code>application/json</code>.",
"name": "Typ treści",
"required": true,
"type": "HEADER"
}

Zwróć uwagę, że możesz użyć tagów HTML w opisie.

Parametr szablonu definiuje zmienną w ścieżce zasobu. Na przykład definiujesz dwa dla zasobu z parametrami szablonu. Zwróć uwagę, że każda definicja parametru w tablicy parametrów jest oddzielony przecinkiem:

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

Następnie możesz użyć parametrów szablonu w definicji ścieżki zasobu umieszczonej w nawiasie „{}”. Możesz na przykład ustawić ścieżkę na:

/login/{org_name}/{developer_email}

Na stronie SmartDocuments API użytkownik musi edytować URL, dodając przed nim fragmenty org_name i developer_email mogą przesłać prośbę.

Definiowanie metody

Zdefiniuj co najmniej 1 metodę dla każdego zasobu. Definicja metody określa czasownik HTTP które można wywołać dla zasobu. Zasób może mieć zdefiniowaną 1 metodę lub z użyciem wielu metod.

W ramach definiowania metody określ wszelkie używane przez nią parametry, w tym zapytanie z parametrami nagłówka. W opisie powyżej znajdziesz zasoby na temat dodawania parametrów. do metody.

Poniższy obraz przedstawia istniejącą stronę SmartDocuments dla interfejsu Apigee Create Developer API z każdego podświetlonego obszaru strony odpowiadającym wartości ustawionej podczas definiowania :

Następny obraz przedstawia tę samą stronę, ale z wybranym opisem treści żądania:

Aby zdefiniować metodę:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w w menu administracji Drupala.
  3. Przy modelu, który chcesz zaktualizować, w sekcji Operacje wybierz opcję Interfejs API Wersje, aby wyświetlić wszystkie wersje modelu.
  4. Wybierz wersję do edycji.
  5. Na stronie wersji wybierz Dodaj metodę z menu jednej z dostęp do zasobów.
  6. Na stronie Edit Method (Edytuj metodę) wpisz te informacje:
    • Wyświetlana nazwa: nazwa interfejsu API, która jest również tytułem Strona Drupala dla interfejsu API.
    • Opis: opisz interfejs API.
    • Metoda Czasownik: typ czasownika HTTP.
    • Schematy zabezpieczeń: określ tryb uwierzytelniania (jeśli jest) . Więcej informacji znajdziesz w artykule Konfigurowanie uwierzytelniania SmartDocuments. .
    • Typ treści: typ treści żądania i odpowiedzi. Zobacz poniżej, aby dowiedzieć się, jak skonfigurować różne metody uwierzytelniania.
    • Parametry: (opcjonalne) dowolne parametry zapytania lub nagłówka dla danej metody. Więcej informacji o dodawaniu parametru do zasobu znajdziesz powyżej.
    • Request Body documentation (Dokumentacja treści żądania): (opcjonalnie) opisz treść żądania. OPUBLIKUJ i PUT przyjmują treść żądania. W tym miejscu możesz go opisać. Jeśli to pominiesz wartość, link Description w sekcji Treść żądania jest pominięty. z wygenerowanej strony SmartDocuments.
    • Przykład treści żądania: (opcjonalnie) pokaż przykład treści żądania, zwykle jako obiekt JSON lub jako XML. W przypadku czasowników POST i PUT tekst żądania Przykład jest przekazywany w ramach każdego żądania. Użytkownicy strony SmartDokumenty edytują to przed wysłaniem żądania do interfejsu API. Jeśli pominiesz tę wartość, parametr Link Wartość w sekcji Treść żądania jest pominięty w parametrze wygenerowanej stronie SmartDocuments.
    • Tagi: tablica tagów powiązanych z interfejsem API. Dokumenty Google używają tagów do: pogrupować podobne interfejsy API. Możesz np. zastosować tag „Statystyki” do wszystkich interfejsów API na temat statystyk. W jednym tagu możesz grupować interfejsy API z różnych zasobów. jeśli używają tego samego tagu.
  7. Kliknij Dodaj metodę. Nastąpi przekierowanie na stronę modelu. Teraz możesz z renderowaniem i publikowaniem metody.

Renderowanie modelu

Po dodaniu interfejsów API do modelu możesz go wyrenderować. Renderowanie konwertuje i opisu interfejsu API do węzłów Drupala. Po zakończeniu renderowania będziesz mieć dla każdego interfejsu API, gdzie każdy węzeł Drupala odpowiada stronie HTML.

Możesz wyrenderować cały model naraz lub wybrać poszczególne interfejsy API jak renderowanie.

Aby wyrenderować model:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty Google w w menu administracji Drupala.
  3. W przypadku modelu, który chcesz wyrenderować, wybierz Wersje interfejsu API w Operacje.
  4. Wybierz wersję, którą chcesz wyrenderować. Możesz renderować węzły tylko z jednej wersji w modelu.
  5. Wybierz metody renderowania.
  6. Wybierz Render Nodes (Renderowanie węzłów) z sekcji Update (Zaktualizuj). options.
  7. Kliknij Aktualizuj.
  8. Pojawi się ekran wczytywania z informacjami o postępie w renderowaniu węzłów.
    Po wyrenderowaniu węzłów identyfikator węzła Drupal każdego interfejsu API pojawi się w kolumnie Kolumna Powiązanie węzłów modelu. Kliknij link w węźle Powiązanie, aby zobaczyć wyrenderowany węzeł.

Zamiast wybierać Renderuj węzły,możesz wybrać Renderuj i publikować węzły, aby renderować i natychmiast opublikować interfejsy API jako węzeł Drupal.

Publikowanie węzłów

Węzeł nie jest widoczny dla użytkowników portalu do czasu jego opublikowania. Opcjonalnie możesz przy publikacji węzłów podczas renderowania. Jeśli nie zdecydujesz się na publikację węzłów, opublikować je ręcznie po zakończeniu renderowania.

Aby opublikować węzeł:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty Google w w menu administracji Drupala.
  3. W przypadku modelu, który chcesz opublikować, wybierz Wersje interfejsu API w Operacje.
  4. Wybierz wersję, którą chcesz opublikować. Węzły można publikować tylko z jednej wersji modelu.
  5. Wybierz metody publikacji.
  6. Wybierz węzły w wersji do opublikowania.
  7. Wybierz Publish Nodes (Opublikuj węzły) z menu Update (aktualizacja). options.
  8. Kliknij Aktualizuj.
  9. Przejdź do węzła, wybierając jego identyfikator w sekcji Powiązanie węzła .

Domyślnie adres URL opublikowanego węzła interfejsu API w Drupal ma format http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>. Aby kontrolować formę adresu URL, wykonaj te czynności:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Konfiguracja > Wyszukiwanie i metadane > Aliasy URL > Wzorce w menu administracji Drupala.
  3. W sekcji Wzorzec dla wszystkich ścieżek metod w Dokumentach Google określ, jak chcesz aby wygenerować ścieżkę.
  4. Kliknij Zapisz konfigurację.

Ze względu na buforowanie w portalu strony modeli mogą nie pojawiać się od razu po ich opublikowaniu. W razie potrzeby możesz ręcznie wyczyścić pamięć podręczną HTML SmartDocuments, korzystając z następującą procedurę:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Konfiguracja > SmartDocuments w administracji Drupala .
  3. Kliknij Utwórz ponownie pamięci podręczne modelu SmartDocuments.

Cofanie publikacji węzła

W dowolnym momencie możesz cofnąć publikację opublikowanego węzła. Cofnięcie publikacji węzła sprawia, że jest on niewidoczny dla użytkowników portalu.

Aby cofnąć publikację węzła:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty Google w w menu administracji Drupala.
  3. W przypadku modelu, którego publikację chcesz cofnąć, wybierz Wersje interfejsu API w sekcji Operacje.
  4. Wybierz wersję modelu węzła, którego publikację chcesz cofnąć.
  5. Wybierz węzły w wersji, których publikację chcesz cofnąć.
  6. Wybierz węzły Cofnij publikację w sekcji Aktualizuj. options.
  7. Kliknij Aktualizuj.

Wyświetlanie wersji modelu

Nową wersję modelu możesz utworzyć przez zaimportowanie nowego pliku WADL lub specyfikacji OpenAPI w istniejącym modelu lub ręcznie tworząc nową wersję. Po utworzeniu nowej wersji możesz wyrenderować i opublikować wersję, co zastąpi obecnie opublikowane węzły Drupal.

Możesz renderować i publikować węzły z wielu wersji jednocześnie. Czyli: możesz publikować węzły z dowolnej lub wszystkich wersji. Jednak publikowanie interfejs API w jednym modelu, który jest taki sam jak opublikowany węzeł z innego modelu, cofa publikację starszego wersji interfejsu API i zastępuje ją wersją z ostatnio opublikowanej wersji API.

Aby wyświetlić wersję modelu:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. W przypadku modelu, który chcesz zaktualizować, wybierz Wersje interfejsu API w Operacje.
  4. Wybierz wersję modelu, którą chcesz wyświetlić.
  5. Renderuj i opublikuj węzły w sposób opisany powyżej.

Edytowanie węzła

Po wyrenderowaniu węzła możesz go edytować za pomocą edytora Drupal. Możesz na przykład edytować czasownik HTTP i opis interfejsu API albo dodaj do interfejsu API nowy parametr zapytania lub nagłówka. Ty mogą edytować węzły utworzone z pliku WADL lub specyfikacji OpenAPI oraz węzły utworzone przez użytkowników, ręcznie.

Możesz też zmodyfikować oryginalny plik WADL lub specyfikację OpenAPI. Gdy skończysz zaimportujesz plik WADL lub specyfikację OpenAPI z powrotem do modelu jako nową wersję, a następnie wyrenderuj i opublikuj zmiany w sposób opisany powyżej.

Aby edytować węzeł za pomocą edytora Drupal:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Przejdź do węzła Drupal odpowiadającego dokumentacji interfejsu API, którą chcesz edytować.
  3. Wybierz Edytuj, aby użyć edytora Drupal.
  4. Po zakończeniu edycji wybierz Update Method (Metoda aktualizacji).

Możesz też edytować węzeł z modelu SmartDocuments:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. W przypadku modelu, który chcesz zaktualizować, wybierz Wersje interfejsu API w Operacje.
  4. Wybierz wersję modelu, którą chcesz opublikować.
  5. W menu Operacje wybierz Edytuj metodę dla którą chcesz edytować.

Aby usunąć węzeł:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. W przypadku modelu, który chcesz zaktualizować, wybierz Wersje interfejsu API w Operacje.
  4. Wybierz wersję modelu, którą chcesz opublikować.
  5. Wybierz Metoda usuwania w menu Operacje dla tej metody.
    Uwaga: usunięcie węzła powoduje też usunięcie interfejsu API z modelu. Jeśli tylko chcą cofnąć publikację interfejsu API, aby ukryć go przed użytkownikami portalu, ale nie chcą go usuwać. z modelu, musisz cofnąć publikację węzła w sposób opisany powyżej.

Portal ma wbudowany raport z informacjami o dowolnym węźle wyrenderowanym przez Model Dokumentów Google, który nie odwołuje się już do prawidłowych metod modelu. Aby uzyskać dostęp do raportu, wykonaj następujące czynności: wybierz Raporty w menu Drupal, a następnie wybierz raport. o nazwie stan węzła SmartDocuments.

Eksportowanie i importowanie modelu

SmartDocuments umożliwia wyeksportowanie istniejącego modelu do pliku. Możesz na przykład zdefiniować w środowisku produkcyjnym i testowym. Wszystkie zmiany w Dokumentach Google możesz wprowadzać na etapie przejściowym. dla środowiska. Gdy zechcesz udostępnić interfejsy API, wyeksportuj model przejściowy i zaimportuj go w model produkcyjny.

Zaimportowanie modelu powoduje utworzenie jego nowej wersji. SmartDocuments próbuje dopasować istniejące Interfejsy API w modelu z zaimportowanymi interfejsami API. Jeśli SmartDokumenty wykryje dopasowanie, importowanie aktualizacji odbywa się na platformie Drupal. odpowiadający obecnemu interfejsowi API. Jeśli SmartDocuments nie wykryje dopasowania, tworzy nowy węzeł Drupala dla interfejsu API.

Załóżmy, że masz interfejs API POST, który odpowiada węzłowi Drupal o identyfikatorze 91. Ty to importuje model, a SmartDocuments wykryje dopasowanie interfejsu API POST w zaimportowanym modelu do istniejącego POST API. Wszelkie aktualizacje interfejsu POST API są następnie aktualizowane w węźle Drupal 91. Jeśli SmartDocuments nie wykryje , utworzy on nowy węzeł Drupala o nowym identyfikatorze.

Drupal przeprowadza dopasowanie, korzystając z tych cech interfejsu API:

  • internalName: nazwa modelu wewnętrznego.
  • httpMethod: metoda HTTP interfejsu API, np. GET, PUT, POST lub USUŃ.
  • resourcePath: ścieżka zasobu.
  • query params (Parametry zapytania): dowolne parametry zapytania używane przez interfejs API.

Jeśli wszystkie 4 cechy zaimportowanego interfejsu API pasują do istniejącego interfejsu API w modelu, Dokumenty SmartDokumenty zaktualizują istniejący węzeł Drupal.

Wyeksportowany model jest reprezentowany przez pojedynczy obiekt JSON z wpisami dla zasobów i . Oznacza to, że możesz edytować wyeksportowany model, aby zmodyfikować zasób lub metodę, a następnie ponownie zaimportować model. Jeśli edytujesz obiekt JSON, nie zmieniaj tych pól:

  • revisionNumber
  • createdTime
  • modifiedTime
  • apiRevisionId
  • resourceId

Aby wyeksportować model:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. W przypadku modelu, który chcesz wyeksportować, wybierz opcję Eksportuj w Operacje.
  4. Jako typ eksportowanego pliku wybierz SmartDocument JSON.
  5. Kliknij Eksportuj.
  6. Pojawi się prośba o zapisanie pliku na dysku lub otworzenie go w edytorze.

Aby zaimportować model:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. Przy modelu, który chcesz zaimportować, wybierz opcję Importuj Operacje.
  4. Wybierz Plik JSON SmartDocuments w menu Wybierz format.
  5. Wybierz Plik lub URL w Typ przesyłania:
    1. Jeśli wybierzesz Plik, przejdź do pliku JSON.
    2. Jeśli wybierzesz URL, podaj adres URL pliku JSON SmartDocuments.
  6. Kliknij Importuj, aby zaimportować go do modelu.
  7. Przekierujemy Cię na stronę z informacjami o modelu, na której możesz wyrenderować model atrybucji. Pamiętaj, że podczas importu zostanie utworzona nowa wersja modelu.
  8. Wyrenderuj i opublikuj węzły.

Edytowanie szablonu SmartDocuments

Szablon SmartDocument określa sposób, w jaki węzły Drupal są wyświetlane na ekranie. Wszystkie dokumenty inteligentne model może korzystać z tego samego szablonu domyślnego. Możesz też ręcznie dostosować szablon używany w modelu indywidualnego.

Szablon SmartDocuments zawiera plik szablonu zakodowany jako .hbr Handlebars, pliki CSS, i JavaScript. W przypadku filmów na kierownicy znaczna część treści zmienia się w zależności wyrażenia na kierownicę, na przykład &123;&123;body}}. Listę Wyrażenia na kierownicy są podane w komentarzu na początku pliku. Informacje na temat: za pomocą Pokrętła, aby dostosować szablony, wejdź na http://handlebarsjs.com.

W poniższych sekcjach opisano, jak przesłać niestandardowy plik szablonu Dokumentów Google do wykorzystania przez wszystkich nowych modeli lub jak przy importowaniu nowych interfejsów API do istniejącego modelu, jak przywrócić oryginalnego domyślnego pliku szablonu SmartDocument oraz instrukcje, jak zmodyfikować ten szablon modelu indywidualnego.

Przesyłam niestandardowy Plik szablonu Dokumentów Google

Możesz przesłać niestandardowy plik szablonu SmartDocuments jako plik .hbr z panelami sterowania, aby używać go jako szablon domyślny przy tworzeniu nowych modeli lub importowaniu nowych interfejsów API do istniejącego modelu.

Jeśli chcesz użyć domyślnego pliku szablonu SmartDocuments jako punktu wyjścia swojego niestandardowego pliku szablonu Dokumentów Google, możesz pobrać jego kopię z: profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

Aby przesłać niestandardowy plik szablonu Dokumentów Google:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Konfiguracja > Inteligentne Dokumenty w Drupalu w menu administracji.
  3. Rozwiń na stronie obszar Ustawienia zaawansowane.
  4. W sekcji Prześlij dostosowany szablon metody kliknij Wybierz plik. przejdź do pliku .hbr „Handlebars”.
  5. Kliknij Prześlij.
  6. Kliknij Save Configuration (Zapisz konfigurację).

Przywracam aplikację domyślny plik szablonu SmartDocuments

Możesz przywrócić domyślny plik szablonu SmartDocuments. Po przywróceniu domyślne Dokumenty SmartDokumenty plik szablonu będzie używany przy tworzeniu nowych modeli lub importowaniu nowych interfejsów API do istniejącego model atrybucji.

Aby przywrócić domyślny plik szablonu SmartDocuments:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Konfiguracja > Inteligentne Dokumenty w Drupalu w menu administracji.
  3. Rozwiń na stronie obszar Ustawienia zaawansowane.
  4. W sekcji Prześlij dostosowany szablon metody kliknij Usuń obok niestandardowy plik szablonu SmartDocuments.
  5. Kliknij Save Configuration (Zapisz konfigurację).

Modyfikuję szablon SmartDocument dla pojedynczego modelu

Możesz zmodyfikować szablon używany na potrzeby pojedynczego modelu.

Aby zmodyfikować szablon dla modelu indywidualnego:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > Dokumenty inteligentne w menu administracji Drupala.
  3. Przy modelu, który chcesz edytować, wybierz Ustawienia w sekcji Operacje.
  4. W obszarze Szablon metody wprowadź odpowiednie zmiany w szablonie.
  5. Kliknij Zapisz szablon.
  6. Przejdź do węzła Drupal. Na stronie powinny być widoczne zmiany w szablonie.

Konfigurowanie Typ uwierzytelniania SmartDocuments

Interfejsy API zdefiniowane w SmartDokumentach mogą być otwarte, co oznacza, że nie są dostępne żadne dane uwierzytelniające lub bezpieczne. Bezpieczny interfejs API wymaga podania danych logowania podczas tworzenia do interfejsu API.

W przypadku bezpiecznego interfejsu API SmartDocuments obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie podstawowe – przekazuj podstawowe dane uwierzytelniające jako nazwę użytkownika i hasło. Jeśli nie wybierzesz protokołu OAuth jako typu danych logowania, interfejs API domyślnie jest używane uwierzytelnianie podstawowe.
  • OAuth 2.0 – zewnętrzny dostawca usług uwierzytelnia uwierzytelnianie użytkownika dane uwierzytelniające, sprawdzić, czy użytkownik ma autoryzację do interfejsu API, a następnie przyznać dostęp token. Gdy wysyłasz żądanie SmartDocuments do chronionego interfejsu API, SmartDocuments stworzy żądanie i wysyła ją do dostawcy usług. Następnie dostawca usług weryfikuje token i sprawdza, że nie wygasła.
  • Token niestandardowy – do każdego z nich przekaż wartość tokena jako nagłówek lub parametr zapytania. użytkownika.

Dla każdego typu uwierzytelniania tworzysz schemat zabezpieczeń, który określa do poszczególnych cech uwierzytelniania. Na przykład w przypadku uwierzytelniania tokenem niestandardowym schemat zabezpieczeń określa sposób przekazywania tokena (nagłówek, parametr zapytania, parametr treści) i nazwę token.

Schemat zabezpieczeń jest powiązany z konkretną wersją modelu. Dlatego, jeśli utworzysz nową wersję modelu, musisz ponownie zdefiniować schematy zabezpieczeń dla tej wersji

W pliku WADL możesz określić, czy interfejs API wymaga uwierzytelniania, korzystając z tagu Apigee &lt;apigee:authentication&gt; poniżej:

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method>

Jeśli interfejs API jest otwarty, ustaw atrybut required na wartość false.

Pamiętaj, że nie można określić typu uwierzytelniania w pliku WADL. W tym celu i edytuję węzeł w Drupal. Więcej informacji o plikach WADL znajdziesz tutaj: WADL Plik referencyjny.

Na stronie interfejsu API w Drupalze funkcją SmartDocuments (Dokumenty) dodaje się następujący przycisk, aby użytkownicy mogli podstawowych danych uwierzytelniających:

Jeśli zmodyfikujesz węzeł, aby ustawić typ uwierzytelniania na OAuth, Dokumenty SmartDocuments ten przycisk do strony:

W przypadku tokena niestandardowego SmartDocuments dodaje:

Konfiguruję uwierzytelnianie podstawowe

Jeśli używasz interfejsu API z uwierzytelnianiem podstawowym, musisz tylko określić tag &lt;apigee:authentication&gt; w WADL za pomocą którego utworzysz model.

Aby zastosować uwierzytelnianie podstawowe do metod utworzonych ze źródła innego niż plik WADL:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > w menu administracji Drupala.
  3. Przy odpowiednim modelu wybierz Wersje interfejsów API w sekcji Operacje.
  4. W przypadku wersji modelu, którą chcesz edytować, wybierz opcję Zabezpieczenia Ustawienia w sekcji Operacje.
  5. Wybierz Dodaj schemat zabezpieczeń.
  6. Podaj nazwę schematu zabezpieczeń.
  7. Jako Typ wybierz Podstawowe.
  8. Wybierz Prześlij.
  9. W przypadku każdej metody w modelu edytuj ją, aby ustawić jej schemat zabezpieczeń zgodnie ze schematem podstawowym.
    1. Wybierz Treść > w menu administracji Drupala.
    2. Przy odpowiednim modelu wybierz Wersje interfejsów API w sekcji Operacje.
    3. Przy wersji modelu, którą chcesz edytować, wybierz opcję Wersja Szczegółowe informacje w sekcji Operacje.
    4. W przypadku interfejsu API, który chcesz edytować, wybierz Edit Method (Edytuj metodę).
    5. Wybierz Schemat zabezpieczeń dla interfejsu API.
    6. Zapisz interfejs API.

Konfiguruję Uwierzytelnianie OAuth 2.0

Możesz skonfigurować model do używania protokołu OAuth 2.0 w Dokumentach inteligentnych zamiast domyślnego uwierzytelnianie. Protokół OAuth konfigurujesz w dwóch miejscach:

  1. Utwórz schemat zabezpieczeń dla każdej wersji modelu w sekcji Zabezpieczenia Ustawienia wersji.
  2. Podaj identyfikator klienta i tajny klucz klienta dla wszystkich wersji modelu w Ustawienia modelu.
.

Aby włączyć OAuth:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > w menu administracji Drupala.
  3. Przy odpowiednim modelu w sekcji Operacje wybierz Wersje interfejsów API.
  4. W przypadku wersji modelu, którą chcesz edytować, wybierz Ustawienia zabezpieczeń w Operacje.
  5. Wybierz Dodaj schemat zabezpieczeń.
  6. Podaj nazwę schematu zabezpieczeń.
  7. Jako Typ wybierz OAuth 2.0.
  8. Ustaw Typ uwierzytelnienia.
  9. Wpisz wartości w polach Adres URL autoryzacji. Autoryzacja Adres URL jest używany do uzyskania tokena dostępu.
  10. Ustaw Terminownik autoryzacji jako GET lub POST.
  11. Wpisz URL tokena dostępu. Adres URL tokena dostępu to adres URL używany do wymienić token żądania na token dostępu.
  12. Wpisz nazwę parametru tokena dostępu.
  13. Użyj wartości In, aby określić sposób przekazywania tokena: Header (Nagłówek), Zapytanie lub Treść.
  14. Ustaw zakresy protokołu OAuth.
  15. Wybierz Prześlij.
  16. Wybierz Treść > w menu administracji Drupala.
  17. Dla modelu wybierz Ustawienia w sekcji Operacje .
  18. Wpisz wartości w polach Client ID (Identyfikator klienta) i Client (Klient). Tajne.
  19. Kliknij Zapisz ustawienia uwierzytelniania szablonu.
  20. W przypadku każdej metody w modelu edytuj ją, aby ustawić jej schemat zabezpieczeń do schematu zabezpieczeń OAuth.
    1. Wybierz Treść > w menu administracji Drupala.
    2. Przy odpowiednim modelu wybierz Wersje interfejsów API w sekcji Operacje.
    3. Przy wersji modelu, którą chcesz edytować, wybierz opcję Wersja Szczegółowe informacje w sekcji Operacje.
    4. W przypadku interfejsu API, który chcesz edytować, wybierz Edit Method (Edytuj metodę).
    5. Wybierz Schemat zabezpieczeń dla interfejsu API.
    6. Zapisz interfejs API.

Konfigurowanie uwierzytelniania przy użyciu tokena niestandardowego

Możesz skonfigurować model do korzystania z uwierzytelniania tokenem niestandardowym.

Aby włączyć tokeny niestandardowe:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub do tworzenia treści.
  2. Wybierz Treść > w menu administracji Drupala.
  3. Przy odpowiednim modelu wybierz Wersje interfejsów API w sekcji Operacje.
  4. W przypadku wersji modelu, którą chcesz edytować, wybierz opcję Zabezpieczenia Ustawienia w sekcji Operacje.
  5. Wybierz Dodaj schemat zabezpieczeń.
  6. Podaj nazwę schematu zabezpieczeń.
  7. Jako Typ wybierz Apikey.
  8. W polu Nazwa parametru podaj token.
  9. Użyj In, aby określić sposób przekazywania parametru token: Header (Nagłówek), Query (Zapytanie), lub Treść.
  10. Wybierz Prześlij.
  11. W przypadku każdej metody w modelu edytuj ją, aby ustawić jej schemat zabezpieczeń do schematu tokenów.
    1. Wybierz Treść > w menu administracji Drupala.
    2. Przy odpowiednim modelu wybierz Wersje interfejsów API w sekcji Operacje.
    3. Przy wersji modelu, którą chcesz edytować, wybierz opcję Wersja Szczegółowe informacje w sekcji Operacje.
    4. W przypadku interfejsu API, który chcesz edytować, wybierz Edit Method (Edytuj metodę).
    5. Wybierz Schemat zabezpieczeń dla interfejsu API.
    6. Zapisz interfejs API.

Usuwanie modelu

Gdy usuniesz model (Zawartość > Dokumenty inteligentne, Usuń w w polu Operacje w Drupal), model zostanie usunięty z organizacji Edge. Oznacza to, że jeśli inne portale odwołują się do modelu, nie jest on już dostępny. Aby dowiedzieć się więcej, Więcej informacji znajdziesz w artykule Informacje o modelach i szablonach SmartDoc.