Swagger API Documentation Support
Swagger support is only available inBloomreach Experience Manager v14 for theDelivery API v0.9.
The Delivery API v0.9 and Swagger areno longer supported as of Bloomreach Experience Manager v15.
API Documentation in Swagger Format
The Delivery API (formerly Page Model API) v0.9 supports a Swagger API documentation endpoint at/swagger.json by default. For example, if the URI endpoint of the Delivery API ishttp://localhost:8080/site/resourceapi/, then you can access the Swagger API documentation throughhttp://localhost:8080/site/resourceapi/swagger.json. A Swagger UI web application (as shown in the screenshot below) can be installed and configured for developers to read and try it out through UI.
To install the Swagger UI web application locally, see the example at/api-docs and the configurations in rootpom.xml for the cargo.run profile in theTestSuite project.
Customizing Swagger Path Info
If you need to change the Swagger API documentation endpoint path info from/swagger.json to something else, configure pagemodelapi.v09.apiDocPath property in/WEB-INF/hst-config.properties:
# Customizing Swagger Path Info to /my-swagger.json in this example...pagemodelapi.v09.apiDocPath = /my-swagger.json