Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Je nach Server muss <host> durch den Server (z. B. preview1) ersetzt werden. Das Ergebnis ist ein JSON Dokument das aus dem Browser kopiert werden muss:

Image Modified

Hinweis

Bitte beachten Sie, dass der Zugriff auf das Open-API Dokument nur auf Testservern funktioniert.

...

  1. Account unter SwaggerHub anlegen

  2. Bei SwaggerHub einloggen

  3. Neue API erstellen:
    Image Modified

  4. Dialog wie folgt ausfüllen:
    Image Modified

  5. Create API klicken

  6. Nun öffnet sich die Swagger-UI mit OpenAPI Editor. Im linken Teil befindet sich der Editor und im rechten Teil die Dokumentation der API

  7. Nun das zuvor kopierte OpenAPI JSON Dokument von der URL 'http://localhost:8080/amparex/webaxapi/v2/api-docs' ins linke Editor Fenster kopieren:
    Image Modified

  8. Bei der Frage ob von JSON in XAML konvertiert werden soll, bitte ja klicken

  9. Nun wird rechts in der Vorschau die API Dokumentation angezeigt:
    Image Modified

  10. Dieses Dokument ist die Dokumentation der API. Im oberen Teil befinden sich die einzelnen Zugriffsmethoden der API. Im unteren Teil ist das Model d. h. die Entitäten (z. B. Artikel) beschrieben.

  11. Im Kopfmenü von SwaggerHub gibt es eine Download Schaltfläche über diese kann einfach ein RestClient Projekt erstellt wird. Mit dem komfortabel die API verwendet werden kann:
    Image Modified

  12. Dort sind die verschiedensten Sprachen zu finden. In unserem Beispiel wird ein Java Client erstellt.

  13. Das erstellte Zip File wird gespeichert:


  14. Das Projekt kann in einer Java Entwicklungsumgebung geöffnet werden. Am Besten erstellt man sich daraus ein JAR File.

  15. Eine 'Test Main Klasse' zeigt die Verwendung des Rest Java Clients:

    Codeblock
    languagejava
    titleRest Client Verwendung
    import io.swagger.client.api.ArticlesApi;
    import io.swagger.client.api.LoginApi;
    import io.swagger.client.model.*;
    
    import java.util.List;
    
    public class Main {
        public static void main(String[] args) throws Exception {
            // Configuration
            LoginApi loginApi = new LoginApi();
            ApiClient apiClient = loginApi.getApiClient();
            apiClient.setBasePath("https://preview8.amparex.net/amparex/webaxapi");   // base path, set hosthere
            apiClient.setConnectTimeout(3 * 1000); // 3 seconds
            apiClient.setReadTimeout(30 * 1000);  // 30 seconds
            apiClient.setWriteTimeout(10 * 1000); // 10 seconds
    
            // use your user, password and alias here
            // login and get security token (Bearer token)
            SecToken secTokenWrap = loginApi.getSecTokenUsingPOST("tester", "tester!8X", "pa-a-ffh6ioqxzje-ceabuy_dtzdvp_h0hwjitjvyls=");
            String secToken = secTokenWrap.getValue();
    
            // create search query for articles
            ArticleSearchQuery articleSearchQuery = new ArticleSearchQuery();
            articleSearchQuery.setName("Ace");
            SearchQueryMetaData searchQueryMetaData = new SearchQueryMetaData();
            searchQueryMetaData.setLimit(10);
            searchQueryMetaData.setPage(1);
            articleSearchQuery.setMetaData(searchQueryMetaData);
    
            // search articles
            ArticlesApi articlesApi = new ArticlesApi();
            apiClient.setApiKey("Bearer " + secToken);
            ListResultWrapperArticleOverview listResultWrapperArticleOverview = articlesApi.searchArticlesUsingPOST("pa-a-ffh6ioqxzje-ceabuy_dtzdvp_h0hwjitjvyls=",articleSearchQuery);
            List<ArticleOverview> list = listResultWrapperArticleOverview.getResult();
            for (ArticleOverview articleOverview : list) {
                System.out.println(articleOverview);
            }
        }
    }