Fügen Sie eine App hinzu
Hinzufügen einer neuen Anwendung oder eines neuen Dienstes durch Importieren der API-Spezifikation
Sie können Ihre App der großen Zahl von Ultradox-Anwendern zur Verfügung stellen, indem Sie einfach Ihre API-Spezifikation im Format Swagger 2.0 oder Google Discovery importieren.
Importieren der API
Sie können Ihre API importieren, indem Sie den Menüpunkt API importieren aus dem Datei-Menü im Ultradox-Editor wählen.
Importieren Sie entweder die API-Spezifikation von Google Drive oder geben Sie eine öffentliche URL ein, unter der die Spezifikation zu finden ist.
Ultradox erstellt dann Bausteine für jede Methode und generiert eine Dokumentation für Ihre Anwendung.
Nach dem Import der API müssen Sie eventuell zusätzliche Informationen wie das Oauth2 client secret und passwort eingeben, wenn Ihre Anwendung eine Authentifizierung erfordert.
Gelistet als privat
Die neuen Bausteine finden Sie in der Sidebar direkt nach dem Import der API.
Es wird als privat unter Weitere in der Seitenleiste aufgeführt, bis Sie ihre API veröffentlichen.
Optimierung der API
Um die Benutzerfreundlichkeit zu verbessern, müssen Sie eventuell Ihre API-Spezifikation optimieren.
Bevor wir eine neue App akzeptieren können, die in unserem öffentlichen Verzeichnis gelistet wird, müssen wir sicherstellen, dass sie leicht verständlich und einfach zu bedienen ist, da die meisten Ultradox Benutzer keine Entwickler sind.
Tags
Tags, die in Ihrer API-Spezifikation definiert sind, werden als Unterkategorien in der Seitenleiste des Bausteins angezeigt. Vergewissern Sie sich, dass Sie kurze und aussagekräftige Namen vergeben, für eine gute Benutzerfreundlichkeit.
Jede Operation mit dem gleichen Tag wird unter der entsprechenden Unterkategorie einsortiert.
Icons
Um ansprechende Icons für Ihre Bausteine in der Sidebar zu erhalten, erstellen Sie ein Icon entweder im svg oder png Format mit 64x64 Pixeln, veröffentlichen es im Web und spezifizieren die URL in Ihrer Spezifikation mit Hilfe der x-logo Erweiterung.
Sie müssen mindestens ein Symbol für Ihre Anwendung im info Bereich Ihrer API-Spezifikation angeben.
info:
version: '1.0'
title: Friends+Me
x-logo:
url: 'https://www.mydomain.com/friendsme.png'
...
Sie können auch für jede Methode ein eindeutiges Symbol angeben.
Wenn Sie Icons pro Methode erstellen, sollte jedes Icon Ihre Anwendung widerspiegeln. Fügen SIe nur ein Overlay hinzu, um die verschiedenen Methoden zu unterscheiden.
Wenn auf Ebene der Methode kein Icon angegeben ist, wird das generische Icon Ihrer Anwendung verwendet.
paths:
/users.identity:
get:
x-logo:
url: 'https://www.mydomain.com/getidentity.png'
...Texte
Ultradox verwendet die Informationen aus Ihrer API Spezifikation im Ultradox Editor auf verschiedene Weise.
Die x-summary Erweiterung im Info Bereich des Spec wird im Dialog Weitere als Beschreibung Ihrer API angezeigt.
Das Icon und der Name Ihrer App (in diesem Beispiel Friends+Me) ist das Info Element Ihrer Spezifikation.
Die Unterkategorien (z.B. Benutzer oder Teams) werden als Tags definiert.
Das Symbol und der Titel jedes Bausteins, die in der Seitenleiste angezeigt werden, stammen aus den Feldern x-logo und x-title in jeder Operation in Ihrer Spezifikation.
Die Zusammenfassung Ihres Vorgehens wird direkt auf dem Baustein angezeigt, nachdem Sie ihn in die Automation gezogen haben.
Beschreibung
Die Beschreibung Ihrer API und der einzelnen Operationen wird bei der Erstellung der Online-Hilfe verwendet.
Sie können Abschriften verwenden, um die Beschreibung Ihrer API zu formatieren.
Behalten Sie Ihre Zielgruppe im Auge und vermeiden Sie Fachausdrücke in der Beschreibung Ihrer Tätigkeiten.
OAuth2
Ultradox übernimmt die Authentifizierung für Ihre Anwendung, wenn die Sicherheit in Ihrer API-Spezifikation richtig definiert ist.
Da Ultradox auf dem Server läuft, auch wenn die Benutzer nicht online sind, können Sie den implicit Oauth-Flow nicht nutzen. Die einzige Operation, die unterstützt wird, ist accessCode.
Access-Tokens können verfallen. Um die Access-Tokens ohne Benutzerinteraktion aktualisieren zu können, müssen Sie die x-refreshUrl in Ihrer Sicherheitsdefinition angeben.
Beispiel für eine funktionierende Sicherheitsdefinition im yaml Format:
securityDefinitions:
auth:
type: oauth2
flow: accessCode
authorizationUrl: https://api.friendsplus.me/oauth.authorize
tokenUrl: https://api.friendsplus.me/oauth.access
x-refreshUrl: https://api.friendsplus.me/oauth.token
scopes:
'admin': Administer your user account
'drafts': Access and modify your drafts
'drafts.read': Access information about your drafts
'drafts.write': Create and modify your drafts
'identity': Confirm your identity, email and avatar
...Stellen Sie sicher, dass die Bereiche richtig definiert sind und die optionalen Bereiche in jeder Operation korrekt referenziert werden.
Veröffentlichen
Veröffentlichen Sie Ihre API
Under construction ...
Questions and Feedback
If you have any comments on this page, feel free to add suggestions right to the Google document that we are using to create this site.
If you are not yet member of the Ultradox community on Google+, please join now to get updates from our end or to provide feedback, bug reports or discuss with other users.
Last Updated: 3/20/18