Wie durchsuche ich die REST API mittels Swagger?

Überblick

metasfresh verwendet Swagger, um REST API-Funktionen und Endpunkte darzustellen.

Über Swagger lassen sich alle verfügbaren Endpunkte durchsuchen und nutzen.
Weitere Informationen zur Verwendung der REST-API findest du in unserem allgemeinen Guide zum metasfresh Webservice.

Abhängig von der metasfresh Build-Version kann man auf die REST-API zugreifen, indem der folgende Pfad an die persönliche Instanz/Server-URL angehängt wird, die in der Regel mit https://<deinserver:port> beginnt:

Builds bis Version 5.175

• metasfresh webui (webapi) REST API
  • /swagger-ui/index.html

    Hinweis: Nützlicher Endpunkt für die Anwendung von Migrationsskripten..

• metasfresh application server REST API
  • /app/swagger-ui/index.html

Builds ab Version 5.176 (Java 17)

Die Instanz/Server-URL dieser Build-Versionen ist immer gleich aufgebaut: https://<yourserver:port>/swagger-ui/index.html.
Zum Durchsuchen enthalten die Swagger-Webseiten oben ein Suchfeld “Explore”, in das der URL-Pfad eingegeben werden kann, um den gewünschten REST-API-Endpunkt zu öffnen.

• metasfresh webui (webapi) REST API
  • /v3/api-docs
    
• metasfresh application server REST API
  • /app/v3/api-docs
    

Nächste Schritte (optional)

• Ändere die Sprache der Benutzersitzung mittels Swagger.
• Aktiviere die Entwickleransicht mittels Swagger.