Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
orbit::routing::Router::RouteBuilder Class Reference

A builder class for fluent route configuration. More...

#include <Router.hpp>

Collaboration diagram for orbit::routing::Router::RouteBuilder:

Public Member Functions

 RouteBuilder (Router &router, http::HttpMethod method, const std::string &path, std::vector< Middleware > mws={})
 
RouteBuilder & summary (const std::string &s)
 
RouteBuilder & description (const std::string &s)
 
RouteBuilder & tag (const std::string &t)
 
RouteBuilder & req_body (const std::string &schema_name)
 
RouteBuilder & res_body (int status, const std::string &schema_name)
 
void handler (RouteHandler h)
 

Private Attributes

Router & router_
 
http::HttpMethod method_
 
std::string path_
 
std::vector< Middleware > mws_
 
openapi::RouteMetadata meta_
 

Detailed Description

A builder class for fluent route configuration.

Constructor & Destructor Documentation

◆ RouteBuilder()

orbit::routing::Router::RouteBuilder::RouteBuilder ( Router &  router,
http::HttpMethod  method,
const std::string &  path,
std::vector< Middleware >  mws = {} 
)
inline

Member Function Documentation

◆ description()

RouteBuilder & orbit::routing::Router::RouteBuilder::description ( const std::string &  s)
inline

◆ handler()

void orbit::routing::Router::RouteBuilder::handler ( RouteHandler  h)

◆ req_body()

RouteBuilder & orbit::routing::Router::RouteBuilder::req_body ( const std::string &  schema_name)
inline

◆ res_body()

RouteBuilder & orbit::routing::Router::RouteBuilder::res_body ( int  status,
const std::string &  schema_name 
)
inline

◆ summary()

RouteBuilder & orbit::routing::Router::RouteBuilder::summary ( const std::string &  s)
inline

◆ tag()

RouteBuilder & orbit::routing::Router::RouteBuilder::tag ( const std::string &  t)
inline

Member Data Documentation

◆ meta_

openapi::RouteMetadata orbit::routing::Router::RouteBuilder::meta_
private

◆ method_

http::HttpMethod orbit::routing::Router::RouteBuilder::method_
private

◆ mws_

std::vector<Middleware> orbit::routing::Router::RouteBuilder::mws_
private

◆ path_

std::string orbit::routing::Router::RouteBuilder::path_
private

◆ router_

Router& orbit::routing::Router::RouteBuilder::router_
private

The documentation for this class was generated from the following file: