Skip to main content

Overview​

The ADITO server provides a web interface for exploring the definition and structure of exposed REST web services. The Swagger UI is a browser-based tool that allows developers to view and interact with REST endpoints provided by the ADITO system.

  • Available since: Version 2023.1.3 (partial), full support as of 2024.0.0
  • URL template: http://<ip>:<port>/afs/swagger
  • Default port: Typically 8080, unless configured otherwise

Version Behavior​

VersionDisplayed Web Services
2023.1.3+Only web services defined via "Entities as REST Web Services"
2024.0.0+All defined REST web services
info

The “Entities as REST Web Services” approach defines REST endpoints based on the data model configuration within ADITO.

Accessing Swagger UI​

To open the Swagger UI in a browser, use the following URL pattern:

http://<ip>:<port>/afs/swagger

Replace <ip> and <port> with the appropriate values for your ADITO environment.

For more information, visit the official Swagger UI documentation.

Interface Example​

SwaggerUI Figure: Swagger UI displaying available REST endpoints

Notes​

tip

Use the Swagger UI to test endpoints interactively or to generate client code using the OpenAPI specification.

info

For technical reasons, OAuth2 is never listed as a supported authentication method, even if it is configured.

warning

Access to the Swagger UI may require authentication depending on the server configuration.