Swagger Generation

You can easily generate a Swagger spec for the API from annotations in the code.

Install Swagger to the project bin folder.

make swagger-install

Generate the Swagger spec: swagger.json.

make swagger

Serve the Swagger spec and open a browser window to view and make requests. You need to enable the healthcheck and cors plugins for this testable UI to function properly. You will also need the app running as well.

make swagger-serve

You can also generate SDKs and a CLI to interact with the API. You can read more about it here.