OpenAPI
Status of the experimental HTTP route extension.
rspc-openapi is an unfinished extension for assigning HTTP methods and paths to procedures. It is not a complete OpenAPI document generator for this rewrite.
What exists
The source provides OpenAPI::get, post, put, patch, and delete. Calling .build() creates an extension that records the route metadata. A separate mount function creates an Axum router.
Limits
Query-parameter decoding, path-parameter inputs, form bodies, and response handling are incomplete. Do not assume that a registered route produces a complete schema or a client-compatible public API.
If you need a public REST API, define and test that HTTP contract in your web framework. Specta's OpenAPI exporter is a separate crate for types and operation schemas. It is not a drop-in replacement for this rspc extension.
Last updated on