Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
We wtorek 2 czerwca 2015 r. udostępniliśmy nową chmurową wersję portalu usług dla deweloperów Apigee.
Jeśli masz pytania, odwiedź stronę pomocy Apigee.
Listę wszystkich informacji o wersjach Apigee Edge znajdziesz w artykule Informacje o wersjach Apigee.
Nowe funkcje
Ogólna dostępność SmartDocs
SmartDocs przechodzi z wersji beta do wersji ogólnodostępnej. Aktualizacje i nowe funkcje:
- Obsługa Swagger 2.0, w tym importowanie za pomocą pliku lub adresu URL, w tym obsługa obiektów zabezpieczeń o niestandardowych nazwach.
- Ulepszenia wizualne w szablonach, które generują dokumenty inteligentne.
- Ulepszenia dotyczące użyteczności i procesów w portalu dla deweloperów, dostępne w menu Treści > SmartDocs w Drupalu.
- Metoda uwierzytelniania „Token niestandardowy” została teraz zastąpiona metodą „Klucz API”.
- Obiekty „security” uwierzytelniania zdefiniowane na poziomie poprawki.
- Konfiguracja uwierzytelniania klienta na poziomie szablonu. Nowe wersje nie resetują żadnych wstępnie skonfigurowanych danych logowania klienta SmartDocs.
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 przekształcania SmartDocs
Jeśli korzystasz już z SmartDocs w wersji beta, nowe funkcje i możliwości w wersji ogólnodostępnej wymagają uaktualnienia SmartDocs na portalu deweloperskim.
Strony SmartDocs, które zostały już opublikowane w portalu deweloperskim, będą nadal działać, ale przed edytowaniem lub opublikowaniem zmian na istniejących lub nowych stronach musisz wykonać proces aktualizacji.
Pamiętaj, że chociaż możesz renderować i publikować dokumenty SmartDocs w portalu dewelopera, dokumenty te są generowane na podstawie modelu interfejsu API, który znajduje się w usłudze zarządzania interfejsem API na krawędzi od firmy Apigee. Wszelkie zmiany wprowadzone w modelu interfejsu API w Edge będą takie same we wszystkich środowiskach Pantheon (podobnie jak deweloperzy w różnych środowiskach Pantheon).
Aby przejść z wersji beta SmartDocs do wersji ogólnodostępnej
- Zaktualizuj i przetestuj wersję 15.05.27 w środowiskach rozwojowym lub testowym w Pantheon.
- Utwórz nowy model, aby zastąpić dowolny dotychczasowy model interfejsu API, którego używasz.
- Jeśli importujesz dokumenty Swagger lub WADL, zaimportuj je ponownie do nowej wersji.
- Jeśli model interfejsu API był aktualizowany za pomocą modułu SmartDocs, wyeksportuj go jako plik JSON SmartDocs i zaimportuj do nowego modelu za pomocą załącznika.
- Ustaw właściwości zabezpieczeń wersji modelu. Na stronie Treść >
SmartDocs > model wybierz Ustawienia zabezpieczeń.
- Sprawdź dowolną wstępnie skonfigurowaną metodę uwierzytelniania na stronie ustawień modelu (Treści >
SmartDocs) przez kliknięcie Ustawień w kolumnie Operacje.
- Zaktualizuj wszystkie szablony niestandardowe, aby używały zasobów CSS i JS w wersji 6. Wprowadź zmiany, aby uwzględnić nowe nazwy obiektów, np. authSchemes i apiSchema. Informacje o aktualizowaniu szablonów SmartDocs znajdziesz w artykule Używanie SmartDocs do dokumentowania interfejsów API.
- Ponownie wyrenderuj i opublikuj zaktualizowany model.
- Po zweryfikowaniu nowej dokumentacji zaktualizuj portal produkcyjny do wersji 15.05.27.
Jeśli jesteś klientem Edge Enterprise i masz pytania lub wątpliwości dotyczące procesu aktualizacji, wyślij e-maila na adresy marsh@apigee.com i cnovak@apigee.com. W przeciwnym razie skorzystaj z społeczności Apigee, aby uzyskać najlepszą odpowiedź.
Naprawione błędy
W tej wersji naprawiliśmy te błędy:
Identyfikator problemu | Opis |
---|---|
DEVSOL-487 | Format dnia w sekcji Monetyzacja powinien być konfigurowalny przez administratorów W sekcji Monetyzacja w ustawieniach monetyzacji możesz teraz wybrać format daty: europejski lub amerykański. |
DEVSOL-603 | Strona planu konfliktowego ma niewłaściwy format Podczas kupowania planu, który pokrywa się z dotychczasowym 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ązanie problemu polega na tym, że po wysłaniu żądania z poziomu SmartDocs i usunięciu parametru szablonu w dokumentacji metody parametry szablonu nie są edytowalne. |
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, a programiści będą mogli zmieniać swoje adresy e-mail. |
DEVSOL-1273 | „DevConnect Mint” pojawia się dwukrotnie na liście modułów W sekcji „Moduły” „Dev Connect Mint” był wyświetlany dwukrotnie. Problem został już rozwiązany. |
DEVSOL-1313 | Obsługa importowania plików JSON/YAML lub URL-i w przypadku Swaggera i WADL Teraz możesz importować pliki WADL za pomocą adresu URL, a pliki Swaggera możesz przesyłać. |
DEVSOL-1339 | Zmiana lokalizacji menu administracyjnego SmartDocs SmartDocs znajduje się teraz w menu treści, a ustawienia SmartDocs w menu administracyjnym ustawień. |
DEVSOL-1340 | Usuwanie wersji beta podczas przechodzenia do GA SmartDocs znajduje się teraz w menu treści, a ustawienia SmartDocs są w menu administracyjnym ustawień. |
DEVSOL-1390 | Biblioteka PHP SDK Edge została zaktualizowana w celu rozwiązania problemu wywoływania funkcji __toString() Biblioteka PHP SDK Edge została zaktualizowana w celu rozwiązania problemu wywoływania funkcji __toString() w obiekcie DeveloperRatePlan, który powoduje ten błąd: {quote} Błąd krytyczny: wywołanie funkcji członkowskiej format() w nieobiekcie w pliku /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php na linii 221 {quote} Ten błąd dotyczy tylko klientów Monetization, którzy używają kodu niestandardowego do wywoływania metody toString(). |
DEVSOL-1398 | Model sklepu zoologicznego SmartDocs importowany podczas instalacji bez pytania użytkownika Aby przedstawić bardziej wyczerpujący przykład korzystania z SmartDocs, podczas instalacji witryny (http://petstore.swagger.io/v2/swagger.json) SmartDocs importuje teraz przykład swagger sklepu zoologicznego (http://petstore.swagger.io/v2/swagger.json) zamiast modelu pogody. |
DEVSOL-1407 | Cron zawodzi, gdy jest wielu deweloperów Podczas uruchamiania crona Drupala duża liczba deweloperów spowodowała problem z limitem czasu. Jeśli organizacja ma więcej niż 200 użytkowników, jest używany proces zbiorczy. |
DEVSOL-1470 | Utwórz link do menu „Interfejsy API” i odpowiednią stronę Portal dla deweloperów SmartDocs zawiera teraz domyślnie link do renderowanej dokumentacji SmartDocs w menu głównym „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 metody Petstore Example SmartDocs nie są prawidłowo renderowane w nowej instalacji
Przykładowe strony metody sklepu ze zwierzętami w SmartDocs nie są prawidłowo renderowane w nowej instalacji. Aby rozwiązać ten problem:
Węzły powinny się teraz prawidłowo renderować. |