docs: consolidate design documentation and standardize crate English
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
# api-macros
|
||||
|
||||
Defines transport-independent API metadata from public traits. The same declarations drive optional HTTP adapters and OpenAPI generation, while callers retain authentication, authorization, and application state.
|
||||
|
||||
## Main entry points
|
||||
|
||||
- [`api`] — API declaration and validation
|
||||
- [`ApiContract`], [`Operation`], and [`WebSocketOperation`] — typed operation contracts
|
||||
- `axum`, `reqwest`, and `openapi` — adapters and document generation enabled by their respective features
|
||||
Reference in New Issue
Block a user