Developers can interact with the web service through programmatic requests using API description standards. The API interface complies with the OpenAPI version 3 specification and has a Swagger interface for development and debugging.
General API Description: The OpenAPI specification provides a clear and understandable description of your API, including available endpoints, methods (GET, POST, PUT, DELETE, and others), query parameters, headers, response codes, and data types.
Specification structure:
Swagger UI provides a visual interface where you can explore the API, see available endpoints, and run test requests directly from your browser. You can enter the required parameters, send requests, and view responses, making it easier to understand how the API works and test its functionality. If the API specification is updated, Swagger UI automatically reflects these changes, providing up-to-date information.