Paxeer Docs logo

Swagger API Documentation

Learn how to enable and access Swagger API documentation for your Paxeer node. Configure the swagger endpoint in app.toml and view interactive API docs.

Swagger Docs Endpoint

To enable the Swagger docs endpoint, you need to update api.swagger value to true in the app.toml file:


[api]

# Swagger defines if swagger documentation should automatically be registered.

swagger = true

Once the node is restarted, the Swagger docs will be available at http://<node-ip>:<port>/swagger/ (e.g. http://localhost:1317/swagger/).

The default API port is 1317. Ensure the API server is enabled in your app.toml under the [api] section by setting enable = true.