Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Verwenden Sie den Inhaltstyp „Basic Page“ von Drupal, um Ihrem Entwicklerdienste-Portal Dokumentation zu Ihrer API hinzuzufügen, z. B. Anleitungen und API-Referenzdokumente, und Inhalte wie Videos, Screencasts oder Codedownloads hinzufügen.
Die Dokumentationsseite enthält einige erste Einträge, die in verschiedene Kategorien wie „Erste Schritte“ und „Tutorials“ eingeteilt sind. Die Seite ist der Ausgangspunkt für die Bearbeitung. Auf diese Weise können Sie eigene Inhaltseinträge hinzufügen und diese nach Wunsch organisieren.
Startseite der Dokumentation hinzufügen
Die Startseite der Dokumentation befindet sich standardmäßig unter <siteURL>/documentation in Ihrem Entwicklerportal. Die Standardstartseite des Entwicklerportals enthält im Feld oben auf der Startseite einen Link zu dieser Seite:
Sie können im Hauptmenü des Entwicklerportals auch einen Link zur Dokumentation zu dieser Seite hinzufügen.
Die Startseite der Dokumentation ist jedoch nicht standardmäßig vorhanden. Daher müssen Sie im Entwicklerportal mit der richtigen URL eine neue Seite erstellen.
So fügen Sie Ihrem Entwicklerportal die Startseite der Dokumentation hinzu:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Verwaltungsmenü von Drupal Inhalt > Inhalte hinzufügen > Seite „Basic“ aus.
- Geben Sie den Titel des Dokuments, z. B. Startseite der Dokumentation, und den Inhalt der ersten Seite ein.
- Klicken Sie auf Zusammenfassung bearbeiten, um eine Zusammenfassung hinzuzufügen.
- Klicken Sie unter dem Abschnitt Text auf Menüeinstellungen.
- Wählen Sie Link zur Speisekarte angeben aus, fügen Sie den Linktitel hinzu und wählen Sie im übergeordneten Element <Hauptmenü> aus.
Dadurch wird ein Link zum Hauptmenü der Dokumentations-Startseite hinzugefügt. - Klicken Sie unter dem Textbereich auf URL-Pfadeinstellungen.
- Heben Sie die Auswahl von Automatischer URL-Alias generieren auf und legen Sie als URL-Alias „Dokumentation“ fest.
Standardmäßig lautet die URL einer Seite <siteURL>/content/pageName. Durch Festlegen des URL-Alias geben Sie eine explizite URL der Seite an, in diesem Fall <siteURL>/documentation. - Speichern Sie die Seite.
In der Menüleiste sollte jetzt ein Link zur Seite angezeigt werden. Der Link im Feld auf der Startseite sollte jetzt funktionieren.
Als Administrator sehen Sie auch Schaltflächen zur Inhaltsverwaltung wie „Anzeigen“ und „Bearbeiten“. Nicht-Administratoren können diese nicht sehen.
Der Dokumentation eine untergeordnete Seite hinzufügen
Beachten Sie beim Hinzufügen von untergeordneten Seiten zu Ihrer Dokumentation Folgendes:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Verwaltungsmenü von Drupal Inhalt > Inhalte hinzufügen > Seite „Basic“ aus.
- Geben Sie den Seitentitel und den Inhalt ein.
- Klicken Sie auf Zusammenfassung bearbeiten, um eine Zusammenfassung hinzuzufügen.
- Klicken Sie unter dem Abschnitt Text auf Menüeinstellungen.
- Klicken Sie auf Link zur Speisekarte angeben und wählen Sie den Menüpunkt auf der Startseite der Dokumentation aus.
Dadurch wird eine aktuelle Seite dem Hauptmenü der Dokumentations-Startseite untergeordnet. - Im Menü „Dokumentations-Startseite“ sollte jetzt ein Link zur entsprechenden Seite angezeigt werden.
Dokumentationsseite bearbeiten
So bearbeiten Sie eine Seite:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Rufen Sie die Seite im Entwicklerportal auf.
Sie können auch im Verwaltungsmenü von Drupal auf Inhalte klicken, um alle Ihre Seiten aufzulisten und eine Seite auszuwählen. - Wählen Sie auf der Seite den Tab Bearbeiten aus.
- Öffnen Sie einen visuellen Editor, indem Sie „Vollständiges HTML“ oder „Gefiltertes HTML“ im Drop-down-Menü „Textformat“ unter dem Abschnitt „Text“ auswählen.
Der Inhalt der Seite sollte im Editor angezeigt werden. - Bearbeiten Sie die Seite nach Bedarf.
- Klicken Sie auf „Speichern“.
Dokumentationsseite anzeigen
So zeigen Sie den Inhalt eines Dokuments an:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Verwaltungsmenü von Drupal Inhalte aus.
- Wählen Sie das Dokument aus, das Sie ansehen möchten.
Reihenfolge von Seiten ändern
Sie können die Reihenfolge und Verschachtelungsebene von Seiten im Menü „Dokumentation“ auf der Startseite ändern.
So ordnen Sie Seiten im Startseitenmenü der Dokumentation neu an:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Drupal-Verwaltungsmenü Struktur > Menüs > Hauptmenü aus.
- Jedes Element im Menü hat links neben dem Namen ein Symbol. Wenn Sie die Symbole nicht sehen, klicken Sie auf Zeilenstärke ausblenden.
- Um ein Element zu verschieben, klicken Sie auf das Symbol und ziehen Sie es an die neue Position.
Wenn Sie ein Element mit untergeordneten Elementen ziehen, werden auch die untergeordneten Elemente verschoben.
- Klicken Sie auf Konfiguration speichern.
Fußzeilenseiten bearbeiten
Die Fußzeile des Portals enthält drei soziale Symbole für Twitter, Facebook und LinkedIn sowie Links mit den folgenden URLs:
- Datenschutzerklärung für die URL <siteURL>/privacy-policy
- Nutzungsbedingungen unter der URL <siteURL>/terms-use
- Kontaktseiten für die URL <siteURL>/contact-us
Bearbeiten Sie diese Seiten, um eigene Inhalte hinzuzufügen.
Wenn diese Seiten nicht vorhanden sind, erstellen Sie sie:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Verwaltungsmenü von Drupal Inhalt > Inhalte hinzufügen > Seite „Basic“ aus.
- Geben Sie den Titel des Dokuments, z. B. Datenschutzerklärung, und den Inhalt der Seite ein.
- Klicken Sie auf Zusammenfassung bearbeiten, um eine Zusammenfassung hinzuzufügen.
- Klicken Sie unter dem Textbereich auf URL-Pfadeinstellungen.
- Wählen Sie Automatischer URL-Alias generieren aus und legen Sie als URL-Alias „Datenschutzerklärung“ fest.
Standardmäßig lautet die URL einer Seite <siteURL>/content/pageName. Durch Festlegen des URL-Alias geben Sie eine explizite URL der Seite an, in diesem Fall <siteURL>/privacy-policy. - Speichern Sie die Seite.
- Wiederholen Sie diesen Vorgang für die Seiten mit den Nutzungsbedingungen und der Kontaktseite.
So bearbeiten Sie den Inhalt einer Fußzeile, z. B. der Datenschutzerklärung, der Nutzungsbedingungen oder der Kontaktseite, in Ihrem Entwicklerportal:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Rufen Sie die Seite auf, indem Sie auf den entsprechenden Link in der Fußzeile klicken. Klicken Sie beispielsweise auf den Link Datenschutzerklärung.
- Klicken Sie auf der Seite auf den Tab Bearbeiten, um den Editor zu öffnen.
- Ändern Sie den Inhalt der Seite mit der Datenschutzerklärung entsprechend.
- Klicken Sie auf Speichern.
- Wiederholen Sie diesen Vorgang für die Seiten mit den Nutzungsbedingungen und der Kontaktseite.
So bearbeiten Sie die Symbole für soziale Netzwerke wie Twitter, Facebook und LinkedIn in Ihrem Entwicklerportal:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Drupal-Verwaltungsmenü Structure > Blocks (Struktur > Blocks) aus.
- Scrollen Sie auf der Seite „Blockierungen“ nach unten, bis Sie den Block Standardfußzeile für die gesamte Website sehen.
- Wählen Sie den Link configure für den websiteweiten Standardfußzeileblock aus.
- Klicken Sie im Bereich Benutzerdefinierter Inhalt mit der rechten Maustaste auf ein Symbol für soziale Netzwerke und wählen Sie im Pop-up-Menü Link bearbeiten aus. Alternativ können Sie das Symbol aus dem Bereich „Benutzerdefinierte Inhalte“ löschen, um es zu entfernen.
- Wählen Sie Block speichern aus, um Ihre Änderungen zu speichern.
JavaScript zu einer Portalseite hinzufügen
Sie können jeder Portalseite JavaScript hinzufügen. Am einfachsten ist es, die Seite zu bearbeiten, um JavaScript hinzuzufügen. Gehen Sie dann so vor:
- Wählen Sie Vollständiges HTML als Textformat aus.
- Klicken Sie auf die Schaltfläche Quelle, um den HTML-Quellcode der Seite zu bearbeiten.
- Fügen Sie der Seite den JavaScript-Code hinzu. Wenn beispielsweise beim Laden der Seite ein Benachrichtigungsfeld angezeigt werden soll, fügen Sie den folgenden Code ein:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
Einige Hinweise zur Verwendung von JavaScript:
- Wenn du auf eine JavaScript-Datei verweisen möchtest, solltest du dies nicht im Quellcode eines Knotens tun, da dadurch ein statischer Link erstellt wird. Verwenden Sie stattdessen PHP-Code, um einen dynamischen Link zu erstellen. So musst du bei einer Änderung des Speicherorts der JavaScript-Datei nicht alle Portalseiten aktualisieren, die darauf verweisen.
- Wenn Sie eine JavaScript-Datei hinzufügen möchten, fügen Sie sie dem Portaldesign hinzu. Wenn sie Teil eines Drupal-Moduls ist, können Sie es dem Modul hinzufügen.
- Sie können auch die Drupal-Funktion drupal_add_js verwenden, um JavaScript in Drupal hinzuzufügen. Weitere Informationen finden Sie unter https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.
Nach fehlerhaften Links suchen
Sie sollten Ihren Content auf fehlerhafte Links überprüfen. Das Entwicklerportal ist standardmäßig so eingerichtet, dass verschiedene Arten von Seiten auf fehlerhafte Links geprüft werden. Beispielsweise werden Links in grundlegenden Seiten, Artikeln, Blogeinträgen und Forenthemen geprüft.
So fügen Sie der Linkprüfung Seitentypen hinzu oder entfernen sie:
- Wählen Sie im Drupal-Verwaltungsmenü die Option Module (Module) aus und prüfen Sie, ob das Modul Link Checker (Linkprüfung) aktiviert ist.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Inhaltserstellung > Linkprüfung aus.
- Konfigurieren Sie die Inhaltstypen, die auf fehlerhafte Links überprüft werden sollen.
Suche konfigurieren
Das Entwicklerportal bietet eine integrierte Suchmaschine, die von Apache Solr implementiert wird und die Apache Lucene-Suchbibliothek verwendet. Das ist die Suchmaschine für die Website selbst, auf die der Nutzer über das Suchfeld rechts oben auf allen Portalseiten zugreift.
Externe Suchmaschinen wie Google können Ihr Portal ebenfalls indexieren. Über das Entwicklerportal können Sie festlegen, ob externe Suchmaschinen Ihr Portal indexieren können oder nicht.
Apache Solr konfigurieren
Sie können Apache Solr so konfigurieren, dass die zu indexierenden Inhaltstypen gesteuert, ein Index erzwungen und zusätzliche Konfigurationsaufgaben ausgeführt werden.
So konfigurieren Sie Apache Solr:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Suche und Metadaten > Apache Solr-Suche aus.
- Auf dieser Seite konfigurieren Sie Apache Solr.
Google-Indexierung deaktivieren
Es empfiehlt sich auch, Ihre Inhalte zu indexieren und für Suchmaschinen verfügbar zu machen. Standardmäßig werden Ihre Inhalte vom Google-Indexierungsindex indexiert. Sie haben jedoch die Möglichkeit, die Google-Indexierung zu deaktivieren. Das bietet sich an, wenn dein Entwicklerportal noch nicht für die öffentliche Nutzung bereit ist und du nicht möchtest, dass deine Inhalte öffentlich suchbar sind.
So deaktivieren Sie die Google-Indexierung:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie im Drupal-Verwaltungsmenü Module aus.
- Aktivieren Sie das Modul Metatags.
- Klicken Sie auf Konfiguration speichern.
- Wählen Sie im Drupal-Verwaltungsmenü Konfiguration > Suche und Metadaten > Meta-Tag aus.
- Wählen Sie den Vorgang Überschreiben für den Typ Global aus.
- Klicken Sie auf den Bereich Erweitert, um ihn zu öffnen.
- Aktivieren Sie das Kontrollkästchen „Verhindern, dass Suchmaschinen diese Seite indexieren“.
- Klicken Sie auf Speichern.
Beachten Sie, dass es auf der Seite „Global“ im Abschnitt „Erweitert“ noch andere suchmaschinenbezogene Optionen gibt. Du kannst beispielsweise ein Kästchen anklicken, um zu verhindern, dass Suchmaschinen Links auf einer Seite folgen. Klicken Sie die gewünschten Kästchen an.
Dokumentation zum Registrieren von Apps
Es ist wichtig, dass deine Dokumentation Anweisungen dazu enthält, wie Entwickler ihre Apps über dein Entwicklerportal registrieren können. Sie können die folgende Anleitung als Ausgangspunkt verwenden. Sie beschreibt, wie Sie Apps über das standardmäßige Entwicklerportal registrieren.
Informationen zum Konfigurieren, wie Entwickler Apps auf Ihrem Portal registrieren, finden Sie unter App-Registrierung konfigurieren. Wenn Sie den Anwendungsregistrierungsprozess ändern, müssen Sie die Beispielanleitung unten entsprechend anpassen.
So registrieren Sie eine App über das standardmäßige Entwicklerportal:
- Wählen Sie im Anmeldemenü unter Ihrem Nutzernamen Meine Apps aus.
- Klicken Sie auf das Symbol Neue App hinzufügen (+).
- Geben Sie die entsprechenden Werte auf der Seite „App hinzufügen“ ein:
App-Name Geben Sie einen eindeutigen App-Namen für Ihre App ein. Callback-URL Geben Sie bei Bedarf die Callback-URL an, an die der OAuth-Aufruf zurückgegeben werden soll.
Standardmäßig ist dieser Wert auch dann erforderlich, wenn Ihre APIs OAuth nicht verwenden. Wenn Ihre APIs OAuth nicht verwenden, geben Sie einen Dummy-Wert wie my.site.com ein.
Produkt Wählen Sie ein oder mehrere API-Produkte aus.. - Klicken Sie auf Anwendung erstellen, um die Anwendung zu registrieren und den API-Schlüssel für die Anwendung zu generieren.