Lib.rs

Cargo Features

[dependencies]
visual_rocket_okapi = { version = "0.8.3", default-features = false, features = ["preserve_order", "swagger", "rapidoc", "uuid", "msgpack", "secrets", "mtls", "rocket_dyn_templates", "rocket_db_pools", "rocket_sync_db_pools", "rocket_ws"] }

default = preserve_order

The preserve_order feature is set by default whenever visual_rocket_okapi is added without default-features = false somewhere in the dependency tree.

preserve_order default

Preserve the order of items in schema and other part of the OpenAPI documentation.

Enables preserve_order of okapi and schemars

swagger

Feature to enable Swagger UI for rendering documentation Project: https://github.com/swagger-api/swagger-ui

Affects visual_rocket_okapi::swagger_ui…

rapidoc

Feature to enable RapiDoc for rendering documentation Project: https://github.com/mrin9/RapiDoc

Affects visual_rocket_okapi::rapidoc…

uuid

Allow the use of UUIDs

Enables uuid of rocket and schemars

msgpack

Re-export Rocket feature flag https://docs.rs/rocket/latest/rocket/serde/msgpack/struct.MsgPack.html

Enables msgpack of rocket

secrets

Re-export Rocket feature flag https://rocket.rs/v0.5/guide/requests/#secret-key

Enables secrets of rocket

mtls

Re-export Rocket feature flag https://rocket.rs/v0.5/guide/configuration/#mutual-tls

Enables mtls of rocket

Features from optional dependencies

rocket_dyn_templates implicit feature

Enables rocket_dyn_templates

rocket_dyn_templates:

Dynamic templating engine integration for Rocket

rocket_db_pools implicit feature

Enables rocket_db_pools

rocket_db_pools:

Rocket async database pooling support

rocket_sync_db_pools implicit feature

Enables rocket_sync_db_pools

rocket_sync_db_pools:

Rocket async database pooling support for sync database drivers

rocket_ws implicit feature

Enables rocket_ws

rocket_ws:

WebSocket support for Rocket