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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
//! Automatic openapi spec generator.
//!
//!
//! # Usage
//!
//! Enable cargo feature by
//!
//! ```toml
//! [dependencies]
//! rweb = { version = "0.6", features = ["openapi"] }
//! serde = "1"
//! tokio = "1"
//! ```
//!
//! and wrap your handlers like
//!
//! ```rust
//! use rweb::*;
//! use serde::Serialize;
//!
//! #[get("/")]
//! fn index() -> String {
//! String::from("content type will be 'text/plain' as you return String")
//! }
//!
//! #[derive(Debug, Serialize, Schema)]
//! struct Product {
//! id: String,
//! price: usize,
//! }
//!
//! #[get("/products")]
//! fn products() -> Json<Vec<Product>> {
//! unimplemented!("content type will be 'application/json', and type of openapi schema will be array")
//! }
//!
//! #[get("/product/{id}")]
//! fn product(id: String) -> Json<Product> {
//! // See Component section below if you want to give a name to type.
//! unimplemented!("content type will be 'application/json', and type of openapi schema will be object")
//! }
//!
//! #[tokio::main]
//! async fn main() {
//! let (_spec, filter) = openapi::spec().build(||{
//! index().or(products()).or(product())
//! });
//!
//! serve(filter);
//! // Use the code below to run server.
//! //
//! // serve(filter).run(([127, 0, 0, 1], 3030)).await;
//! }
//! ```
//!
//! **Note**: Currently using path filter from warp is **not** supported by
//! rweb. If you use path filter from warp, generated document will point to
//! different path.
//!
//! # Annotations
//!
//! This is applicable to `#[get]`, `#[post]`, ..etc
//!
//!
//! ## `#[openapi(id = "foo")]`
//!
//! ```rust
//! use rweb::*;
//!
//! #[get("/sum/{a}/{b}")]
//! #[openapi(id = "math.sum")]
//! fn sum(a: usize, b: usize) -> String {
//! (a + b).to_string()
//! }
//! ```
//!
//!
//! ## `#[openapi(description = "foo")]`
//!
//! ```rust
//! use rweb::*;
//!
//! /// By default, doc comments on the function will become description of the operation.
//! #[get("/sum/{a}/{b}")]
//! #[openapi(description = "But what if implementation details is written on it?")]
//! fn sum(a: usize, b: usize) -> String {
//! (a + b).to_string()
//! }
//! ```
//!
//!
//! ## `#[openapi(summary = "foo")]`
//!
//! ```rust
//! use rweb::*;
//!
//! #[get("/sum/{a}/{b}")]
//! #[openapi(summary = "summary of operation")]
//! fn sum(a: usize, b: usize) -> String {
//! (a + b).to_string()
//! }
//! ```
//!
//! ## `#[openapi(tags("foo", "bar"))]`
//!
//! ```rust
//! use rweb::*;
//!
//! #[get("/sum/{a}/{b}")]
//! #[openapi(tags("sum"))]
//! fn sum(a: usize, b: usize) -> String {
//! (a + b).to_string()
//! }
//!
//! #[get("/mul/{a}/{b}")]
//! #[openapi(tags("mul"))]
//! fn mul(a: usize, b: usize) -> String {
//! (a * b).to_string()
//! }
//!
//! // This is also applicable to #[router]
//! #[router("/math", services(sum, mul))]
//! #[openapi(tags("math"))]
//! fn math() {}
//! ```
//!
//!
//! # Parameters
//!
//! ```rust
//! use rweb::*;
//! use serde::Deserialize;
//!
//! #[derive(Debug, Deserialize, Schema)]
//! struct Opt {
//! query: String,
//! limit: usize,
//! page_token: String,
//! }
//!
//! /// Look at the generated api document, and surprise :)
//! ///
//! /// Fields of [Opt] are documented as query parameters.
//! #[get("/")]
//! pub fn search(_q: Query<Opt>) -> String {
//! String::new()
//! }
//!
//! /// Path parameter is documented. (as there's enough information to document it)
//! #[get("/{id}")]
//! pub fn get(id: String) -> String {
//! String::new()
//! }
//!
//! /// Fields of [Opt] are documented as request body parameters.
//! pub fn store(_: Json<Opt>) -> String{
//! String::new()
//! }
//! ```
//!
//! # Response body
//!
//! ```rust
//! use rweb::*;
//! use serde::Serialize;
//!
//! #[derive(Debug, Default, Serialize, Schema)]
//! struct Output {
//! data: String,
//! }
//!
//! /// Json<T> implements rweb::openapi::ResponseEntity if T implements Entity.
//! #[get("/")]
//! pub fn get() -> Json<Output> {
//! Output::default().into()
//! }
//! ```
//!
//! # Entity
//!
//! See [Entity] for details and examples.
//!
//! # Custom error
//!
//! ```rust
//! use rweb::*;
//! use indexmap::IndexMap;
//! use std::borrow::Cow;
//!
//! #[derive(Debug, Schema)]
//! enum Error {
//! NotFound,
//! }
//!
//! impl openapi::ResponseEntity for Error {
//! fn describe_responses(_: &mut openapi::ComponentDescriptor) -> openapi::Responses {
//! let mut map = IndexMap::new();
//!
//! map.insert(
//! Cow::Borrowed("404"),
//! openapi::Response {
//! description: Cow::Borrowed("Item not found"),
//! ..Default::default()
//! },
//! );
//!
//! map
//! }
//! }
//! ```
pub use self::{
builder::{spec, Builder},
entity::{ComponentDescriptor, Entity, ResponseEntity, Responses},
};
use crate::FromRequest;
use http::Method;
use indexmap::IndexMap;
pub use rweb_openapi::v3_0::*;
use scoped_tls::scoped_thread_local;
use std::{borrow::Cow, cell::RefCell, mem::replace};
mod builder;
mod entity;
scoped_thread_local!(static COLLECTOR: RefCell<Collector>);
#[derive(Debug)]
pub struct Collector {
spec: Spec,
components: ComponentDescriptor,
path_prefix: String,
tags: Vec<Cow<'static, str>>,
}
impl Collector {
/// Method used by `#[op]`
#[doc(hidden)]
pub fn components(&mut self) -> &mut ComponentDescriptor {
&mut self.components
}
/// Method used by `#[router]`.
#[doc(hidden)]
pub fn with_appended_prefix<F, Ret>(
&mut self,
prefix: &str,
tags: Vec<Cow<'static, str>>,
op: F,
) -> Ret
where
F: FnOnce() -> Ret,
{
let orig_len = self.path_prefix.len();
self.path_prefix.push_str(prefix);
let orig_tag_len = self.tags.len();
self.tags.extend(tags);
let new = replace(self, new());
let cell = RefCell::new(new);
let ret = COLLECTOR.set(&cell, || op());
let new = cell.into_inner();
let _ = replace(self, new);
self.tags.drain(orig_tag_len..);
self.path_prefix.drain(orig_len..);
ret
}
pub fn add_request_type_to<T: FromRequest + Entity>(&mut self, op: &mut Operation) {
if T::is_body() {
if op.request_body.is_some() {
panic!("Multiple body detected");
}
let s = T::describe(&mut self.components);
let mut content = IndexMap::new();
// TODO
content.insert(
Cow::Borrowed(T::content_type()),
MediaType {
schema: Some(s),
examples: None,
encoding: Default::default(),
},
);
op.request_body = Some(ObjectOrReference::Object(RequestBody {
content,
required: Some(!T::is_optional()),
..Default::default()
}));
}
if T::is_query() {
self.add_query_type_to::<T>(op);
}
}
fn add_query_type_to<T: FromRequest + Entity>(&mut self, op: &mut Operation) {
debug_assert!(T::is_query());
let s = T::describe(&mut self.components);
let s = self.components.get_unpack(&s);
assert_eq!(
Some(Type::Object),
s.schema_type,
"Query<[not object]> is invalid. Store [not object] as a field."
);
for (name, ps) in &s.properties {
op.parameters.push(ObjectOrReference::Object(Parameter {
name: name.clone(),
location: Location::Query,
required: Some(s.required.contains(name)),
representation: Some(ParameterRepresentation::Simple { schema: ps.clone() }),
..Default::default()
}));
}
}
pub fn add_response_to<T: ResponseEntity>(&mut self, op: &mut Operation) {
// T::describe(&mut self.components);
let mut responses = T::describe_responses(&mut self.components);
for (code, mut resp) in &mut responses {
if let Some(ex_resp) = op.responses.remove(code) {
if !ex_resp.description.is_empty() {
resp.description = ex_resp.description
}
}
}
op.responses.extend(responses);
}
#[doc(hidden)]
#[inline(never)]
pub fn add(&mut self, path: &str, method: Method, operation: Operation) {
let path = {
let mut p = self.path_prefix.clone();
p.push_str(path);
p
};
let v = self
.spec
.paths
.entry(Cow::Owned(path))
.or_insert_with(Default::default);
let op = if method == Method::GET {
&mut v.get
} else if method == Method::POST {
&mut v.post
} else if method == Method::PUT {
&mut v.put
} else if method == Method::DELETE {
&mut v.delete
} else if method == Method::HEAD {
&mut v.head
} else if method == Method::OPTIONS {
&mut v.options
} else if method == Method::CONNECT {
unimplemented!("openapi spec generation for http CONNECT")
} else if method == Method::PATCH {
&mut v.patch
} else if method == Method::TRACE {
&mut v.trace
} else {
unreachable!("Unknown http method: {:?}", method)
};
match op {
Some(op) => {
assert_eq!(*op, operation);
}
None => {
*op = Some(operation);
}
}
let op = op.as_mut().unwrap();
op.tags.extend(self.tags.clone());
}
pub fn add_scheme<T>() {}
fn spec(self) -> Spec {
let mut spec = self.spec;
spec.components
.get_or_insert_with(Default::default)
.schemas
.extend(self.components.build());
spec
}
}
fn new() -> Collector {
Collector {
spec: Default::default(),
components: ComponentDescriptor::new(),
path_prefix: Default::default(),
tags: vec![],
}
}
#[doc(hidden)]
pub fn with<F, Ret>(op: F) -> Ret
where
F: FnOnce(Option<&mut Collector>) -> Ret,
{
if COLLECTOR.is_set() {
COLLECTOR.with(|c| {
let mut r = c.borrow_mut();
op(Some(&mut r))
})
} else {
op(None)
}
}
/// I'm too lazy to use inflector.
#[doc(hidden)]
pub mod http_methods {
use http::Method;
pub const fn get() -> Method {
Method::GET
}
pub const fn post() -> Method {
Method::POST
}
pub const fn put() -> Method {
Method::PUT
}
pub const fn delete() -> Method {
Method::DELETE
}
pub const fn head() -> Method {
Method::HEAD
}
pub const fn options() -> Method {
Method::OPTIONS
}
pub const fn connect() -> Method {
Method::CONNECT
}
pub const fn patch() -> Method {
Method::PATCH
}
pub const fn trace() -> Method {
Method::TRACE
}
}