typeway 0.1.0

Type-level web framework for Rust: your API is a type
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! # Typeway — Type-Level Web Framework for Rust
//!
//! Typeway is a web framework where your entire API is described as a Rust type.
//! Servers, clients, and OpenAPI schemas are all derived from that single type
//! definition. If the types compile, the pieces fit together.
//!
//! Built on Tokio, Tower, and Hyper — fully compatible with the Axum ecosystem.
//!
//! ## Quick Start
//!
//! ```ignore
//! use typeway::prelude::*;
//!
//! // 1. Define path types
//! typeway_path!(type HelloPath = "hello");
//! typeway_path!(type GreetPath = "greet" / String);
//!
//! // 2. Define the API as a type
//! type API = (
//!     GetEndpoint<HelloPath, String>,
//!     GetEndpoint<GreetPath, String>,
//! );
//!
//! // 3. Write handlers
//! async fn hello() -> &'static str { "Hello, world!" }
//! async fn greet(path: Path<GreetPath>) -> String {
//!     let (name,) = path.0;
//!     format!("Hello, {name}!")
//! }
//!
//! // 4. Serve — the compiler verifies every endpoint has a handler
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
//!     Server::<API>::new((
//!         bind!(hello),
//!         bind!(greet),
//!     ))
//!     .serve("0.0.0.0:3000".parse()?)
//!     .await?;
//!     Ok(())
//! }
//! ```
//!
//! ## Feature Flags
//!
//! | Flag | Default | Description |
//! |------|---------|-------------|
//! | `server` | yes | HTTP server (Tower/Hyper) |
//! | `client` | no | Type-safe HTTP client (reqwest) |
//! | `openapi` | no | OpenAPI 3.1 spec generation |
//! | `full` | no | All features |

// --- Core (always available) ---
pub use typeway_core::*;
pub use typeway_macros::*;

// --- Re-export common deps ---
pub use http;
pub use serde;
pub use serde_json;

// --- Server (feature = "server") ---
#[cfg(feature = "server")]
pub use typeway_server::{
    bind, body_from_stream, empty_body, serve, sse_body, BoundHandler, EffectfulLayeredServer,
    EffectfulServer, Extension, FromRequest, FromRequestParts, Handler, Header, IntoResponse, Json,
    JsonError, LayeredServer, NamedHeader, Path, Query, Router, RouterService, SecureHeadersLayer,
    Server, Serves, State,
};

/// Re-export tower-http for middleware (available when `server` feature is on).
#[cfg(feature = "server")]
pub use typeway_server::tower_http;

// --- Client (feature = "client") ---
#[cfg(feature = "client")]
pub use typeway_client::{CallEndpoint, Client, ClientError};

// --- gRPC (feature = "grpc") ---
#[cfg(feature = "grpc")]
pub use typeway_grpc::{
    ApiToProto, ApiToServiceDescriptor, CollectRpcs, GrpcClient, GrpcClientConfig, GrpcClientError,
    GrpcCode, GrpcMultiplexer, GrpcReady, GrpcServiceDescriptor, ToProtoType,
};
#[cfg(feature = "grpc")]
pub use typeway_server::GrpcServer;

// --- Protobuf (feature = "protobuf") ---
#[cfg(feature = "protobuf")]
pub use typeway_protobuf::{BytesStr, ProtoMessage, TypewayDecode, TypewayEncode};
#[cfg(feature = "protobuf")]
pub use typeway_server::{into_direct_handler, Proto};

// --- OpenAPI (feature = "openapi") ---
#[cfg(feature = "openapi")]
pub use typeway_openapi::{
    apply_handler_docs, ApiToSpec, Components, EndpointToOperation, ExampleValue, OpenApiSpec,
    SecurityRequirement, SecurityScheme, ToSchema,
};

/// Convenience prelude — import everything you typically need.
pub mod prelude {
    pub use typeway_core::*;
    pub use typeway_macros::*;

    pub use serde::{Deserialize, Serialize};

    #[cfg(feature = "server")]
    pub use typeway_server::{
        bind, body_from_stream, empty_body, serve, sse_body, tower_http, BoundHandler,
        EffectfulLayeredServer, EffectfulServer, Extension, FromRequest, FromRequestParts, Handler,
        Header, IntoResponse, Json, JsonError, LayeredServer, NamedHeader, Path, Query, Router,
        RouterService, SecureHeadersLayer, Server, Serves, State,
    };

    #[cfg(feature = "client")]
    pub use typeway_client::{CallEndpoint, Client, ClientError};

    #[cfg(feature = "grpc")]
    pub use typeway_grpc::{
        ApiToProto, ApiToServiceDescriptor, CollectRpcs, GrpcClient, GrpcClientConfig,
        GrpcClientError, GrpcCode, GrpcMultiplexer, GrpcReady, GrpcServiceDescriptor, ToProtoType,
    };
    #[cfg(feature = "grpc")]
    pub use typeway_server::GrpcServer;

    #[cfg(feature = "protobuf")]
    pub use typeway_protobuf::{BytesStr, ProtoMessage, TypewayDecode, TypewayEncode};
    #[cfg(feature = "protobuf")]
    pub use typeway_server::{into_direct_handler, Proto};

    #[cfg(feature = "openapi")]
    pub use typeway_openapi::{
        apply_handler_docs, ApiToSpec, Components, EndpointToOperation, ExampleValue, OpenApiSpec,
        SecurityRequirement, SecurityScheme, ToSchema,
    };
}