Best Practices für die Erstellung Ihres Portals

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

Apigee empfiehlt, dass Sie beim Erstellen des Portals die in den folgenden Abschnitten beschriebenen Best Practices anwenden.

Das Zuschauerinteresse aufrecht erhalten

Fügen Sie Inhalte hinzu, die visuell ansprechend sind und die Zuschauer auf mehr Informationen neugierig machen. Ermöglichen Sie es API-Nutzern, einen Teil Ihres Portals zu erkunden, ohne sich anzumelden. Stellen Sie eine Self-Service-Registrierung zur Verfügung, damit diese schnell mit der Verwendung von APIs arbeiten können.

Nutzern die Verwendung Ihrer APIs ermöglichen

Generieren Sie automatisch eine interaktive API-Dokumentation aus Ihren OpenAPI-Spezifikationen, die Nutzern Folgendes ermöglichen:

• Informationen zur API
• Liveanfrage an die API senden

• Von der API zurückgegebene Live-Antwort ansehen

  Weitere Informationen finden Sie unter APIs veröffentlichen.

Auf primäre Lernpfade eingehen

Stellen Sie Beispiele und Anleitungen für die Anwendungsfälle bereit, die für Ihre Zielgruppe relevant sind und auf deren Erfahrung basieren. Veranschaulichen Sie dies am Beispiel einer einfachen curl-Befehlssequenz oder führen Sie ein komplexeres Verfahren durch.

Suchmaschinenoptimierung (SEO) implementieren

Sorgen Sie dafür, dass Ihre Inhalte suchbar sind. Investieren Sie in SEO, um Ihr Ranking in den Suchergebnissen zu verbessern und Nutzern zu ermöglichen, Ihre Inhalte zu finden.

Beachten Sie beim Strukturieren von Inhalten die folgenden Best Practices. Weitere Informationen und zusätzliche Richtlinien von Google finden Sie im Startleitfaden zur Suchmaschinenoptimierung von Google.

Best Practice	Beschreibung	Vorteile
Nutzerfreundliche URLs erstellen	Erstellen Sie leicht verständliche, für Menschen lesbare URLs. Definieren Sie eine nutzerfreundliche Seiten-URL, wenn Sie Ihrem Portal Seiten hinzufügen, wie unter Seite erstellen beschrieben.	Gibt den Zweck der Seite in einer für Menschen lesbaren Form an. Vollständige oder teilweise Keyword-Optionen in der Seiten-URL verbessern das Ranking in der Suche. Normalerweise werden URLs in den Suchergebnissen angezeigt.
Geben Sie einen beschreibenden Portalnamen an.	Definieren Sie einen eindeutigen und beschreibenden Portalnamen für Ihr Portal, wie unter Portale verwalten beschrieben. Dieser Inhalt wird verwendet, um das <title>-Tag für die Startseite (index) Ihres Portals zu füllen.	Vollständiger oder teilweise Keyword-Übereinstimmung im Titel verbessert das Ranking der Suche. Der Inhalt Ihrer Seitentitel wird in der Regel in der ersten Zeile der Suchergebnisse angezeigt.
Einfache Navigation auf der Website	Definieren Sie eine Navigationsstruktur, die für logische Strukturen sinnvoll ist, wie unter Navigation einrichten beschrieben.	Erleichtert den Nutzern die Orientierung. Hilft Nutzern, schnell und einfach die gewünschten Inhalte zu finden.
Gute Keyword-Wortgruppen in allen Inhalten verwenden	Verwenden Sie Keywords in Ihren Inhalten immer dann, wenn es Ihnen sinnvoll erscheint. Die Auffälligkeit einer Keyword-Zeichenfolge auf Ihrer Seite kann das Ranking der Seite in den Suchergebnissen verbessern. Versuchen Sie, die Keyword-Strings vorherzusagen, die Nutzer bei der Suche nach Ihren Inhalten verwenden könnten. Vermeiden Sie Keyword-Verstopfung, d. h. zu viele Keywords zu verwenden, nur um das Suchranking zu verbessern. Dies kann dazu führen, dass Ihrer Website von Suchmaschinen Strafen auferlegt werden.	Bei Nutzern, die nach Inhalten suchen, steigt die Wahrscheinlichkeit, dass sie relevante Treffer erhalten.

Entwickler-Community aufbauen

Nutzen Sie soziale Medien, um Ihre API-Community über Standardkanäle, wie Facebook, Twitter usw. zu bewerben. Veröffentlichen Sie Blogs und Foren, die die Kommunikation und die Interaktion zwischen den Entwicklern in Ihrer API-Community fördern.