Sprawdzone metody tworzenia portalu

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

Podczas tworzenia portalu Apigee zaleca stosowanie sprawdzonych metod opisanych w następnych sekcjach.

Angażowanie odbiorców

Dodaj treści, które wizualnie angażują odbiorców i zachęcają ich do dowiedzenia się więcej. Umożliw użytkownikom interfejsu API przeglądanie części Twojego portalu bez konieczności logowania się. Umożliw rejestrację samodzielną, aby mogli szybko zacząć tworzyć aplikacje korzystające z Twoich interfejsów API.

Pozwalanie użytkownikom na testowanie interfejsów API

Automatyczne generowanie interaktywnej dokumentacji interfejsu API na podstawie specyfikacji OpenAPI, aby umożliwić użytkownikom:

  • Więcej informacji o interfejsie API
  • Wysyłanie żądania do interfejsu API

  • Wyświetlanie odpowiedzi z interfejsu API w czasie rzeczywistym

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

Zajmij się głównymi ścieżkami szkoleniowymi

Podaj przykłady zastosowań i samouczki, które są odpowiednie dla Twoich odbiorców i dostosowane do ich poziomu doświadczenia. Pokaż przykład, np. prostą sekwencję poleceń curl, lub przeprowadź bardziej skomplikowaną procedurę.

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

Zadbaj o to, aby Twoje treści były możliwe do wyszukania. Inwestuj w SEO, które poprawia pozycję w wynikach wyszukiwania i ułatwia użytkownikom znajdowanie Twoich treści.

Optymalizacja witryn pod kątem wyszukiwarek

Stosuj te sprawdzone metody podczas tworzenia struktury treści. Więcej informacji i dodatkowe wytyczne Google znajdziesz w przewodniku Google Optymalizacja witryn pod kątem wyszukiwarek (SEO) – przewodnik dla początkujących.

Sprawdzona metoda Opis Zalety
Tworzenie przyjaznych adresów URL Twórz łatwe do zrozumienia i czytelne adresy URL. Podczas dodawania stron do portalu określ przyjazny dla użytkownika adres URL strony, jak opisano w sekcji Tworzenie strony.
  • przekazuje w zrozumiałej dla człowieka formie cel strony;
  • Dopasowanie pełne lub częściowe słów kluczowych w adresie URL strony poprawia pozycję w wynikach wyszukiwania.
  • Adresy URL zwykle pojawiają się w wynikach wyszukiwania.
Podaj nazwę portalu Podaj unikalną i opisową nazwę portalu zgodnie z opisem w artykule Zarządzanie portalami. Te treści służą do wypełniania tagu <title> na stronie głównej (index) Twojego portalu.
  • Dopasowanie pełne lub częściowe słów kluczowych w tytule poprawia pozycję w wyszukiwarce.
  • Zwykle treść tytułów stron jest wyświetlana jako pierwszy wiersz wyników wyszukiwania.
Zadbaj o łatwe poruszanie się po witrynie Określ strukturę nawigacji, która ma sens logiczny, zgodnie z opisem w artykule Konfigurowanie nawigacji.
  • Ułatwia użytkownikom orientację.
  • Ułatwia użytkownikom szybkie i łatwe znajdowanie treści.
Używaj różnych wyrażeń kluczowych w treściach. Umieszczaj słowa kluczowe w treściach, gdy jest to uzasadnione i ma sens. Wyeksponowanie ciągu znaków słowa kluczowego na stronie może poprawić pozycję strony w wynikach wyszukiwania. Spróbuj przewidzieć ciągi znaków słów kluczowych, których mogą używać użytkownicy, gdy szukają Twoich treści. Uważaj, aby nie stosować przepełniania słowami kluczowymi, czyli nadużywania słów kluczowych tylko po to, aby poprawić pozycję w wynikach wyszukiwania. Może to spowodować nałożenie kary przez wyszukiwarki. Użytkownicy szukający treści będą częściej uzyskiwać trafne wyniki.

Budowanie społeczności deweloperów

Promuj swoją społeczność API w mediach społecznościowych, korzystając ze standardowych kanałów społecznościowych, takich jak Facebook, Twitter itp. Publikuj blogi i fora, które zachęcają do komunikacji i interakcji programistów w Twojej społeczności API.