# utoipa-swagger-ui
[](https://github.com/juhaku/utoipa/actions/workflows/build.yaml)
[](https://crates.io/crates/utoipa-swagger-ui)
[](https://docs.rs/utoipa-swagger-ui/latest/utoipa_swagger_ui/)
This crate implements necessary boiler plate code to serve Swagger UI via web server. It
works as a bridge for serving the OpenAPI documetation created with
[utoipa](https://docs.rs/utoipa/) libarary in the Swagger UI.
**Currently implemented boiler plate for:**
* **actix-web** `version >= 4`
* **rocket** `version >=0.5.0-rc.1`
* **axum** `version >=0.6`
Serving Swagger UI is framework independant thus this crate also supports serving the Swagger UI with
other frameworks as well. With other frameworks there is bit more manual implementation to be done. See
more details at [serve](https://docs.rs/utoipa-swagger-ui/latest/utoipa_swagger_ui/fn.serve.html) or
[examples](https://github.com/juhaku/utoipa/tree/master/examples).
# Features
* **actix-web** Enables actix-web integration with pre-configured SwaggerUI service factory allowing
users to use the Swagger UI without a hazzle.
* **rocket** Enables rocket integration with with pre-configured routes for serving the Swagger UI
and api doc without a hazzle.
* **axum** Enables `axum` integration with pre-configured Router serving Swagger UI and OpenAPI specs
hazzle free.
* **debug-embed** Enables `debug-embed` feature on `rust_embed` crate to allow embedding files in debug
builds as well.
# Install
Use only the raw types without any boiler plate implementation.
```toml
[dependencies]
utoipa-swagger-ui = "2"
```
Enable actix-web framework with Swagger UI you could define the dependency as follows.
```toml
[dependencies]
utoipa-swagger-ui = { version = "2", features = ["actix-web"] }
```
**Note!** Also remember that you already have defined `utoipa` dependency in your `Cargo.toml`
# Examples
Serve Swagger UI with api doc via **`actix-web`**. See full example from [examples](https://github.com/juhaku/utoipa/tree/master/examples/todo-actix).
```rust
HttpServer::new(move || {
App::new()
.service(
SwaggerUi::new("/swagger-ui/{_:.*}")
.url("/api-doc/openapi.json", ApiDoc::openapi()),
)
})
.bind((Ipv4Addr::UNSPECIFIED, 8989)).unwrap()
.run();
```
Serve Swagger UI with api doc via **`rocket`**. See full example from [examples](https://github.com/juhaku/utoipa/tree/master/examples/rocket-todo).
```rust
#[rocket::launch]
fn rocket() -> Rocket<Build> {
rocket::build()
.mount(
"/",
SwaggerUi::new("/swagger-ui/<_..>")
.url("/api-doc/openapi.json", ApiDoc::openapi()),
)
}
```
Setup Router to serve Swagger UI with **`axum`** framework. See full implementation of how to serve
Swagger UI with axum from [examples](https://github.com/juhaku/utoipa/tree/master/examples/todo-axum).
```rust
let app = Router::new()
.merge(SwaggerUi::new("/swagger-ui")
.url("/api-doc/openapi.json", ApiDoc::openapi()));
```
# License
Licensed under either of [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate
by you, shall be dual licensed, without any additional terms or conditions.