Sprawdzone metody tworzenia portalu

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Podczas tworzenia portalu Apigee zaleca stosowanie sprawdzonych metod opisanych w kolejnych sekcjach.

Angażowanie odbiorców

Dodaj treści, które przyciągają uwagę odbiorców i zachęcają ich do dalszego poznawania Twoich materiałów. Umożliw konsumentom interfejsu API przeglądanie części portalu bez logowania. Udostępnij rejestrację samoobsługową, aby mogli szybko zacząć tworzyć aplikacje za pomocą Twoich interfejsów API.

Umożliwianie użytkownikom wypróbowania interfejsów API

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

  • zapoznanie się z interfejsem API,
  • wysłanie żądania na żywo do interfejsu API,

  • wyświetlenie odpowiedzi na żywo zwróconej przez interfejs API.

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

Uwzględnianie głównych ścieżek szkoleniowych

Udostępnij przykłady zastosowań i samouczki, które są istotne dla odbiorców i dostosowane do ich poziomu doświadczenia. Pokaż przykłady, takie jak prosta sekwencja poleceń curl, lub przeprowadź użytkowników przez bardziej złożoną procedurę.

Wdrażanie optymalizacji pod kątem wyszukiwarek (SEO)

Upewnij się, że Twoje treści można wyszukiwać. Zainwestuj w SEO, które poprawi Twoją pozycję w wynikach wyszukiwania i umożliwi użytkownikom znajdowanie Twoich treści.

Optymalizacja witryn pod kątem wyszukiwarek

Podczas tworzenia struktury treści stosuj te sprawdzone metody. Więcej informacji i dodatkowe wskazówki od Google znajdziesz w przewodniku dla początkujących po optymalizacji witryn pod kątem wyszukiwarek Google.

Sprawdzona metoda Opis Korzyści
Tworzenie adresów URL przyjaznych dla użytkowników Twórz łatwe do zrozumienia adresy URL, które są czytelne dla ludzi. Podczas dodawania stron do portalu określ przyjazny dla użytkownika adres URL strony, jak opisano w artykule Tworzenie strony.
  • Przekazuje cel strony w czytelnej dla człowieka postaci.
  • Pełne lub częściowe dopasowanie słów kluczowych w adresie URL strony poprawia pozycję w wynikach wyszukiwania.
  • Adresy URL zwykle pojawiają się w wynikach wyszukiwania.
Podawanie opisowej nazwy portalu Określ unikalną i opisową nazwę portalu, jak opisano w artykule Zarządzanie portalami. Te treści są używane do wypełniania tagu <title> na stronie głównej (index) portalu.
  • Pełne lub częściowe dopasowanie słów kluczowych w tytule poprawia pozycję w wynikach wyszukiwania.
  • Zawartość tytułów stron jest zwykle wyświetlana jako pierwszy wiersz wyników wyszukiwania.
Ułatwianie nawigacji po witrynie Określ logiczną strukturę nawigacji, jak opisano w artykule Konfigurowanie nawigacji.
  • Ułatwia użytkownikom orientację.
  • Pomaga użytkownikom szybko i łatwo znaleźć interesujące ich treści.
Używanie w treści odpowiedniej kombinacji wyrażeń kluczowych Dodawaj słowa kluczowe do treści, gdy jest to istotne i ma sens. Widoczność ciągu słów kluczowych na stronie może poprawić pozycję strony w wynikach wyszukiwania. Spróbuj przewidzieć ciągi słów kluczowych, których użytkownicy mogą używać podczas wyszukiwania Twoich treści. Uważaj, aby nie przeładować strony słowami kluczowymi, czyli nie używać ich nadmiernie tylko po to, aby poprawić pozycję w wynikach wyszukiwania. Może to spowodować nałożenie na Twoją witrynę kary przez wyszukiwarki. Użytkownicy wyszukujący treści będą mieli większe szanse na uzyskanie trafnych wyników.

Budowanie społeczności deweloperów

Używaj mediów społecznościowych do promowania społeczności interfejsu API za pomocą standardowych kanałów społecznościowych, takich jak Facebook, Twitter itp. Publikuj blogi i fora, które wspierają komunikację i interakcję między deweloperami w społeczności interfejsu API.