swagger-ui-dist
| Crates.io | swagger-ui-dist |
| lib.rs | swagger-ui-dist |
| version | |
| source | src |
| created_at | 2024-05-19 19:49:27.436938 |
| updated_at | 2024-12-04 20:35:57.063099 |
| description | packages the JS/CSS code of the swagger-ui in the form of axum routes |
| homepage | |
| repository | https://github.com/apimeister/swagger-ui-dist-rs/ |
| max_upload_size | |
| id | 1245175 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Jens Walter (JensWalter)
documentation
https://docs.rs/swagger-ui-dist
README
The version number reflects the swagger-ui version embedded.
Usage
With Inline OpenAPI
use axum::Router;
use swagger_ui_dist::{ApiDefinition, OpenApiSource};
#[tokio::main]
async fn main() {
let api_def = ApiDefinition {
uri_prefix: "/api",
api_definition: OpenApiSource::Inline(include_str!("petstore.yaml")),
title: Some("My Super Duper API"),
};
let app = Router::new().merge(swagger_ui_dist::generate_routes(api_def));
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
println!("listening on http://localhost:3000/api");
axum::serve(listener, app).await.unwrap();
}
With external Route
use axum::{routing::get, Router};
use swagger_ui_dist::{ApiDefinition, OpenApiSource};
#[tokio::main]
async fn main() {
let api_def = ApiDefinition {
uri_prefix: "/api",
api_definition: OpenApiSource::Uri("/openapi.yml"),
title: Some("My Super Duper API"),
};
let app = Router::new()
.route("/openapi.yml", get(|| async move { include_str!("petstore.yaml") }))
.merge(swagger_ui_dist::generate_routes(api_def));
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
println!("listening on http://localhost:3000/api");
axum::serve(listener, app).await.unwrap();
}