15.05.27.00 – informacje o wersji portalu Apigee dla programistów

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

We wtorek 2 czerwca 2015 r. udostępniliśmy nową wersję w chmurze portalu Apigee Developer Services.

Jeśli masz pytania, skontaktuj się z zespołem pomocy Apigee Edge.

Listę wszystkich informacji o wersjach Apigee Edge znajdziesz w informacjach o wersjach Apigee.

Nowe funkcje

Ogólna dostępność SmartDocs

SmartDocs wychodzi z wersji beta i staje się ogólnie dostępny. Aktualizacje i nowe funkcje obejmują:

  • Obsługa Swaggera 2.0, w tym importowanie według pliku lub adresu URL, a także obsługa obiektów zabezpieczeń o niestandardowych nazwach.
  • Ulepszenia projektu wizualnego w szablonach, które generują dokumenty SmartDocs.
  • Ulepszenia dotyczące użyteczności i przepływu pracy w Portalu dla deweloperów, dostępne w menu Treści > SmartDocs w Drupalu.
  • Uwierzytelnianie znane dotychczas jako „Token niestandardowy” nosi teraz nazwę „Klucz interfejsu API”.
  • Obiekty „security” uwierzytelniania zdefiniowane na poziomie wersji.
  • Konfiguracja uwierzytelniania klienta na poziomie szablonu. Nowe wersje nie resetują już wstępnie skonfigurowanych danych logowania klienta Smart Docs.

Więcej informacji o funkcjach znajdziesz w tym poście na blogu.

Dokumentację SmartDocs znajdziesz w artykule Używanie SmartDocs do dokumentowania interfejsów API.

Proces uaktualniania SmartDocs

Jeśli korzystasz już z SmartDocs w okresie testów beta, nowe funkcje i możliwości w wersji ogólnodostępnej wymagają uaktualnienia SmartDocs w portalu dewelopera.

Wszystkie strony SmartDocs, które zostały już opublikowane w portalu dla deweloperów, będą nadal działać, ale przed edytowaniem lub publikowaniem zmian na istniejących lub nowych stronach musisz przejść proces aktualizacji.

Pamiętaj, że dokumenty SmartDocs możesz renderować i publikować w portalu dla deweloperów, ale są one generowane na podstawie modelu interfejsu API, który znajduje się w usługach zarządzania interfejsami API Edge od Apigee. Wszelkie zmiany wprowadzone w modelu API w Edge będą takie same we wszystkich środowiskach Pantheon (podobnie jak w przypadku deweloperów w środowiskach Pantheon).

Aby przejść z wersji beta SmartDocs na wersję ogólnodostępną:

  1. Zaktualizuj i przetestuj wersję 15.05.27 w środowiskach programistycznym lub testowym w Pantheon.
  2. Utwórz nowy model, który zastąpi dotychczasowy model interfejsu API.
    • Jeśli importujesz dokumenty Swagger lub WADL, zaimportuj je ponownie do nowej wersji.
    • Jeśli model interfejsu API był utrzymywany za pomocą modułu SmartDocs, wyeksportuj go jako plik JSON SmartDocs i zaimportuj do nowego modelu za pomocą załącznika.
  3. Ustaw właściwości zabezpieczeń wersji modelu. Na stronie Treści > SmartDocs > model kliknij Ustawienia zabezpieczeń.
  4. Sprawdź wstępnie skonfigurowane uwierzytelnianie na stronie ustawień modelu (Treści > SmartDocs), klikając Ustawienia w kolumnie Operacje.
  5. Zaktualizuj wszystkie szablony niestandardowe, aby korzystały z wersji 6 zasobów CSS i JS, i wprowadź zmiany odzwierciedlające nowe nazwy obiektów, takie jak authSchemes i apiSchema. Informacje o aktualizowaniu szablonów SmartDocs znajdziesz w artykule Dokumentowanie interfejsów API za pomocą SmartDocs.
  6. Ponownie wyrenderuj i opublikuj zmienioną wersję modelu.
  7. Po sprawdzeniu nowej dokumentacji zaktualizuj portal produkcyjny do wersji 15.05.27.

Jeśli jesteś klientem korporacyjnym Edge i masz pytania lub wątpliwości dotyczące procesu uaktualniania, wyślij e-maila na adresy marsh@apigee.com i cnovak@apigee.com. W innych przypadkach skorzystaj z społeczności Apigee, aby uzyskać najlepszą odpowiedź.

Usunięte błędy

W tej wersji naprawiliśmy te błędy:

Identyfikator problemu Opis
DEVSOL-487 Format dnia w sekcji Zarabianie powinien być konfigurowalny przez administratorów
Format daty można teraz skonfigurować w sekcji Zarabianie w ustawieniach zarabiania dla formatów daty w Europie i Stanach Zjednoczonych.
DEVSOL-603 Strona z informacjami o konflikcie planów jest nieprawidłowo sformatowana
Gdy użytkownik kupuje plan, który pokrywa się z istniejącym planem, wyświetlana strona jest teraz prawidłowo sformatowana.
DEVSOL-642 Przenoszenie konfiguracji na poziomie klienta z ustawień zabezpieczeń do ustawień szablonu
DEVSOL-709 SmartDocs: parametr szablonu URL nie jest edytowalny po wysłaniu żądania z pustą wartością
Rozwiązuje problem, który powoduje, że parametry szablonu nie są edytowalne po wysłaniu żądania z SmartDocs po usunięciu parametru szablonu w dokumentacji metody.
DEVSOL-1013 Umożliwienie edytowania adresów e-mail użytkowników portalu dla programistów
Pole adresu e-mail na stronie edycji profilu nie będzie już wyłączone i programiści będą mogli zmieniać swoje adresy e-mail.
DEVSOL-1273 „DevConnect Mint” wyświetla się 2 razy na liście modułów
W sekcji Moduły „Dev Connect Mint” wyświetlał się 2 razy. Problem został już rozwiązany.
DEVSOL-1313 Obsługa importowania plików JSON/YAML lub adresów URL w przypadku Swaggera i WADL
Pliki WADL można teraz importować za pomocą adresu URL, a pliki Swaggera można przesyłać.
DEVSOL-1339 Zmiana lokalizacji menu administratora SmartDocs
SmartDocs znajduje się teraz w menu treści, a ustawienia SmartDocs są dostępne w menu administratora ustawień.
DEVSOL-1340 Usunięcie wersji beta po przejściu do wersji ogólnodostępnej
SmartDocs znajduje się teraz w menu treści, a ustawienia SmartDocs w menu ustawień administratora.
DEVSOL-1390 Zaktualizowano bibliotekę PHP SDK Edge, aby rozwiązać problem z wywoływaniem funkcji __toString()
Zaktualizowano bibliotekę PHP SDK Edge, aby rozwiązać problem z wywoływaniem funkcji __toString() w obiekcie DeveloperRatePlan, który powoduje ten błąd: {quote} Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221 {quote} Jest to błąd, który dotyczy tylko klientów korzystających z monetyzacji i używających niestandardowego kodu wywołującego metodę toString().
DEVSOL-1398 Model SmartDocs Petstore importowany podczas instalacji bez pytania użytkownika
SmartDocs importuje teraz przykład swaggera petstore podczas instalacji witryny (http://petstore.swagger.io/v2/swagger.json) zamiast modelu pogodowego, aby mieć bardziej wyczerpujący przykład korzystania z SmartDocs.
DEVSOL-1407 Błąd Crona przy dużej liczbie deweloperów
Podczas uruchamiania Crona w Drupalu duża liczba deweloperów spowodowała problem z przekroczeniem limitu czasu. Gdy organizacja ma więcej niż 200 użytkowników, używany jest proces wsadowy.
DEVSOL-1470 Utwórz link do menu „Interfejsy API” i odpowiedni widok
Portal dla deweloperów SmartDocs domyślnie zawiera link do wyrenderowanej dokumentacji SmartDocs w menu głównym o nazwie „Interfejsy API”, który prowadzi do wszystkich modeli z opublikowanymi metodami.

Znane problemy

W tej wersji występują te znane problemy:

Identyfikator problemu Opis
DEVSOL-1558
Strony metod w przykładzie Petstore SmartDocs nie są prawidłowo renderowane w nowej instalacji
Przykładowe strony metod Petstore w SmartDocs nie renderują się prawidłowo w nowej instalacji. Aby rozwiązać ten problem:
  1. W menu Drupal wybierz Treści > SmartDocs.
  2. Wybierz model „Petstore Example”.
  3. W sekcji Opcje aktualizacji wybierz Render and publish nodes (Renderuj i publikuj węzły).
  4. Kliknij pole wyboru Zaznacz / odznacz wszystkie, aby zaznaczyć wszystkie węzły.
  5. Kliknij Aktualizuj.

Węzły powinny się teraz prawidłowo renderować.