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

#include <OpenApi.hpp>

Classes

struct  EndpointMap
 

Public Member Functions

 OpenApiRegistry ()=default
 Each App (root Router) has its own registry; see App::openapi().
 
void register_route (http::HttpMethod method, const std::string &path, const RouteMetadata &meta)
 
void register_schema (const std::string &name, const std::string &json_schema_body)
 
std::string generate_swagger_json (const std::string &title, const std::string &version) const
 

Static Public Member Functions

static OpenApiRegistry & instance ()
 

Private Member Functions

std::string method_to_string (http::HttpMethod method) const
 
std::string escape_json (const std::string &s) const
 

Private Attributes

std::map< std::string, EndpointMap > paths_
 
std::unordered_map< std::string, std::string > schemas_
 
std::mutex mutex_
 

Constructor & Destructor Documentation

◆ OpenApiRegistry()

orbit::openapi::OpenApiRegistry::OpenApiRegistry ( )
default

Each App (root Router) has its own registry; see App::openapi().

Member Function Documentation

◆ escape_json()

std::string orbit::openapi::OpenApiRegistry::escape_json ( const std::string &  s) const
private

◆ generate_swagger_json()

std::string orbit::openapi::OpenApiRegistry::generate_swagger_json ( const std::string &  title,
const std::string &  version 
) const

◆ instance()

static OpenApiRegistry & orbit::openapi::OpenApiRegistry::instance ( )
inlinestatic

Process-wide registry. Schemas registered here are included in every App's spec, so code written before per-App registries keeps working.

◆ method_to_string()

std::string orbit::openapi::OpenApiRegistry::method_to_string ( http::HttpMethod  method) const
private

◆ register_route()

void orbit::openapi::OpenApiRegistry::register_route ( http::HttpMethod  method,
const std::string &  path,
const RouteMetadata &  meta 
)

◆ register_schema()

void orbit::openapi::OpenApiRegistry::register_schema ( const std::string &  name,
const std::string &  json_schema_body 
)

Member Data Documentation

◆ mutex_

std::mutex orbit::openapi::OpenApiRegistry::mutex_
mutableprivate

◆ paths_

std::map<std::string, EndpointMap> orbit::openapi::OpenApiRegistry::paths_
private

◆ schemas_

std::unordered_map<std::string, std::string> orbit::openapi::OpenApiRegistry::schemas_
private

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