Sprawdzone metody tworzenia portalu

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

Apigee zaleca stosowanie podczas tworzenia portalu sprawdzonych metod opisanych w poniższych sekcjach.

Angażuj odbiorców

Dodaj treści, które przyciągną uwagę odbiorców i zachęcą ich do dodatkowych informacji. Pozwól użytkownikom interfejsu API przeglądać część portalu bez konieczności logowania się. Zapewnij im samoobsługową rejestrację, aby mogli szybko zacząć tworzyć aplikacje przy użyciu interfejsów API.

Pozwól użytkownikom wypróbować Twoje interfejsy API

Automatycznie wygeneruj interaktywną dokumentację interfejsu API na podstawie specyfikacji OpenAPI, aby umożliwić użytkownikom:

  • Więcej informacji o interfejsie API
  • Wyślij żądanie na żywo do interfejsu API

  • Wyświetlanie odpowiedzi na żywo zwróconej przez interfejs API

    Więcej informacji znajdziesz w artykule Publikowanie interfejsów API.

Adresowanie podstawowych ścieżek szkoleniowych

Podaj przykłady przypadków użycia i samouczki dopasowane do odbiorców docelowych i oparte na ich poziomie doświadczenia. Możesz to zademonstrować na przykład, używając prostej sekwencji poleceń curl lub przeprowadzenia bardziej złożonej procedury.

Wdrożenie optymalizacji witryn pod kątem wyszukiwarek (SEO)

Upewnij się, że Twoje treści są dostępne dla wyszukiwarki. Zainwestuj w SEO, które poprawi Twoją pozycję w wynikach wyszukiwania i umożliwi użytkownikom znalezienie Twoich treści.

Optymalizacja witryn pod kątem wyszukiwarek

Podczas tworzenia struktury treści korzystaj z tych sprawdzonych metod. Więcej informacji i dodatkowe wskazówki Google znajdziesz we Wprowadzeniu do optymalizacji witryn pod kątem wyszukiwarek (SEO).

Sprawdzona metoda Opis Zalety
Twórz adresy URL przyjazne dla użytkowników Twórz adresy URL łatwe do zrozumienia, zrozumiałe dla człowieka. Podczas dodawania stron do portalu określ przyjazny dla użytkownika adres URL, tak jak to opisano w sekcji Tworzenie strony.
  • przekazuje cel strony w sposób zrozumiały dla człowieka.
  • Pełne lub częściowe dopasowanie słów kluczowych w adresie URL strony poprawia pozycję w rankingu wyników wyszukiwania.
  • Zazwyczaj adresy URL pojawiają się w wynikach wyszukiwania.
Podaj opisową nazwę portalu Zdefiniuj unikalną i opisową nazwę portalu zgodnie z opisem w artykule Zarządzanie portalami. Te treści służą do wypełniania tagu <title> strony głównej portalu (index).
  • Pełne lub częściowe dopasowanie słów kluczowych w tytule poprawia pozycję reklamy w rankingu wyników wyszukiwania.
  • Zazwyczaj treść tytułów stron jest wyświetlana jako pierwszy wiersz wyników wyszukiwania.
Ułatwianie nawigacji w witrynie Zdefiniuj strukturę nawigacji, która ma logiczny sens, zgodnie z opisem w artykule Konfigurowanie nawigacji.
  • Ułatwia orientację użytkownikom.
  • Pomaga użytkownikom szybko i łatwo znaleźć interesujące ich treści.
Stosuj odpowiednie połączenie wyrażeń kluczowych w treści Uwzględnij słowa kluczowe w treści, gdy jest to trafne i ma sens. Widoczność ciągu słowa kluczowego na stronie może poprawić jej pozycję w wynikach wyszukiwania. Spróbuj przewidzieć, jakie ciągi słów kluczowych będą mogli używać użytkownicy podczas wyszukiwania Twoich treści. Uważaj, aby nie udawać słów kluczowych, czyli ich nadużywać, żeby poprawić pozycję w wynikach wyszukiwania. Może to spowodować nałożenie kar na Twoją witrynę przez wyszukiwarki. Dzięki temu wzrośnie prawdopodobieństwo, że użytkownicy szukający konkretnych treści zobaczą trafne działania.

Budowanie społeczności programistów

Wykorzystuj media społecznościowe do promowania swojej społeczności interfejsów API w standardowych kanałach społecznościowych, takich jak Facebook, Twitter itd. Publikuj blogi i fora ułatwiające komunikację i interakcje między programistami w Twojej społeczności interfejsów API.