Thanks to visit codestin.com
Credit goes to docs.rs

Skip to main content

Crate typeway_openapi

Crate typeway_openapi 

Source
Expand description

typeway-openapi — OpenAPI spec generation and codegen.

Two directions:

  • Rust → OpenAPI: Walk an API type and produce an OpenAPI spec (via ApiToSpec).
  • OpenAPI → Rust: Parse an OpenAPI spec (2.x or 3.x) and generate typeway Rust code (via codegen_v2 and codegen_v3).

Re-exports§

pub use codegen_v2::swagger_to_typeway;
pub use codegen_v3::openapi3_to_typeway;
pub use derive::apply_handler_docs;
pub use derive::auto_tag_operations;
pub use derive::collect_security_schemes;
pub use derive::ApiToSpec;
pub use derive::CollectOperations;
pub use derive::EndpointDoc;
pub use derive::EndpointToOperation;
pub use derive::ErrorResponses;
pub use derive::ExampleValue;
pub use derive::QueryParameters;
pub use derive::ToSchema;
pub use spec::Components;
pub use spec::OpenApiSpec;
pub use spec::SecurityRequirement;
pub use spec::SecurityScheme;
pub use swagger_output::to_swagger2;
pub use swagger_output::to_swagger2_json;

Modules§

codegen_common
Shared utilities for OpenAPI → Rust codegen (used by both v2 and v3).
codegen_v2
OpenAPI 2.x (Swagger) → Typeway Rust codegen.
codegen_v3
OpenAPI 3.x → Typeway Rust codegen.
derive
Traits for deriving OpenAPI specs from Typeway API types.
spec
OpenAPI 3.1 specification types.
swagger_output
Convert an OpenAPI 3.x spec to Swagger 2.0 output.