OpenAPI & Swagger UI

You can serve OpenAPI specification files and mount Swagger UI with zero code, just enable the feature and add configuration.

[dependencies]
sword = { version = "x.y.z", features = ["web", "web-swagger-ui"] }

Configuration

Add the [web.openapi] section to config/config.toml:

[web.openapi]
title = "My API"
version = "1.0.0"
spec-file-paths = ["config/openapi.yaml", "config/openapi-test.yaml"]

Once configured, navigate to /docs in your browser to explore your API interactively.

Note on the specification path

If you have a router-prefix configured, it will affect the specification path.

Multiple Specs

You can serve multiple specification files, each one gets its own entry in the URL and is selectable from the Swagger UI dropdown.