utoipa-rapidoc 4.0.0

# utoipa-rapidoc

This crate works as a bridge between [utoipa](https://docs.rs/utoipa/latest/utoipa/) and [RapiDoc](https://rapidocweb.com/) OpenAPI visualizer.

[![Utoipa build](https://github.com/juhaku/utoipa/actions/workflows/build.yaml/badge.svg)](https://github.com/juhaku/utoipa/actions/workflows/build.yaml)
[![crates.io](https://img.shields.io/crates/v/utoipa-rapidoc.svg?label=crates.io&color=orange&logo=rust)](https://crates.io/crates/utoipa-rapidoc)
[![docs.rs](https://img.shields.io/static/v1?label=docs.rs&message=utoipa-rapidoc&color=blue&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/utoipa-rapidoc/latest/)
![rustc](https://img.shields.io/static/v1?label=rustc&message=1.60%2B&color=orange&logo=rust)

Utoipa-rapidoc provides simple mechanism to transform OpenAPI spec resource to a servable HTML
file which can be served via [predefined framework integration](#examples) or used
[standalone](#using-standalone) and served manually.

You may find fullsize examples from utoipa's Github [repository][examples].

# Crate Features

* **actix-web** Allows serving `RapiDoc` via _**`actix-web`**_. `version >= 4`
* **rocket** Allows serving `RapiDoc` via _**`rocket`**_. `version >=0.5`
* **axum** Allows serving `RapiDoc` via _**`axum`**_. `version >=0.7`

# Install

Use RapiDoc only without any boiler plate implementation.
```toml
[dependencies]
utoipa-rapidoc = "4"
```

Enable actix-web integration with RapiDoc.
```toml
[dependencies]
utoipa-rapidoc = { version = "4", features = ["actix-web"] }
```

# Using standalone

Utoipa-rapidoc can be used standalone as simply as creating a new `RapiDoc` instance and then
serving it by what ever means available as `text/html` from http handler in your favourite web
framework.

`RapiDoc::to_html` method can be used to convert the `RapiDoc` instance to a servable html
file.
```rust
let rapidoc = RapiDoc::new("/api-docs/openapi.json");

// Then somewhere in your application that handles http operation.
// Make sure you return correct content type `text/html`.
let rapidoc_handler = move || {
    rapidoc.to_html()
};
```

# Customization

Utoipa-rapidoc can be customized and configured only via `RapiDoc::custom_html` method. This
method empowers users to use a custom HTML template to modify the looks of the RapiDoc UI.

* [All allowed RapiDoc configuration options][rapidoc_api]
* [Default HTML template][rapidoc_quickstart]

The template should contain _**`$specUrl`**_ variable which will be replaced with user defined
OpenAPI spec url provided with `RapiDoc::new` function when creating a new `RapiDoc`
instance. Variable will be replaced during `RapiDoc::to_html` function execution.

_**Overriding the HTML template with a custom one.**_
```rust
let html = "...";
RapiDoc::new("/api-docs/openapi.json").custom_html(html);
```

# Examples

_**Serve `RapiDoc` via `actix-web` framework.**_
```rust
use actix_web::App;
use utoipa_rapidoc::RapiDoc;

App::new().service(RapiDoc::with_openapi("/rapidoc", ApiDoc::openapi()));
```

_**Serve `RapiDoc` via `rocket` framework.**_
```rust
use utoipa_rapidoc::RapiDoc;

rocket::build()
    .mount(
        "/",
        RapiDoc::with_openapi("/rapidoc", ApiDoc::openapi()),
    );
```

_**Serve `RapiDoc` via `axum` framework.**_
 ```rust
 use axum::Router;
 use utoipa_rapidoc::RapiDoc;
 let app = Router::<S>::new()
     .merge(RapiDoc::with_openapi("/rapidoc", 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.

[rapidoc_api]: <https://rapidocweb.com/api.html>
[examples]: <https://github.com/juhaku/utoipa/tree/master/examples>
[rapidoc_quickstart]: <https://rapidocweb.com/quickstart.html>