Crate utoipa_swagger_ui

source · [−]
Expand description

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 libarary in the Swagger UI.

Currently implemented boiler plate for:

  • actix-web

Serving Swagger UI is framework independant thus this crate also supports serving the Swagger UI in with other frameworks as well. With other frameworks there is bit more manual implementation to be done. See more details at serve.

Features

  • actix-web Enables actix-web integration with pre-configured SwaggerUI service factory allowing users to use the Swagger UI without a hazzle.

Install

Use only the raw types without any boiler plate implementation.

[dependencies]
utoipa-swagger-ui = "0.2.0"

Enable actix-web framework with Swagger UI you could define the dependency as follows.

[dependencies]
utoipa-swagger-ui = { version = "0.2.0", 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. 1

HttpServer::new(move || {
        App::new()
            .service(
                SwaggerUi::new("/swagger-ui/{_:.*}")
                    .url("/api-doc/openapi.json", ApiDoc::openapi()),
            )
    })
    .bind((Ipv4Addr::UNSPECIFIED, 8989)).unwrap()
    .run();

  1. actix-web feature need to be enabled. ↩

Structs

Config

Object used to alter Swagger UI settings.

SwaggerFile

Represents servealbe file of Swagger UI. This is used together with serve function to serve Swagger UI files via web server.

SwaggerUi

Entry point for serving Swagger UI and api docs in application. It uses provides builder style chainable configuration methods for configuring api doc urls. In actix-web only 1

Url

Rust type for Swagger UI url configuration object.

Functions

serve

User friendly way to serve Swagger UI and its content via web server.