Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
OpenApi.hpp
Go to the documentation of this file.
1#pragma once
3#include <string>
4#include <vector>
5#include <map>
6#include <unordered_map>
7#include <mutex>
9
10namespace orbit::openapi {
11
13 std::string summary;
14 std::string description;
15 std::vector<std::string> tags;
17 std::unordered_map<int, std::string> response_schemas;
18};
19
21public:
23 OpenApiRegistry() = default;
24
28 static OpenApiRegistry registry;
29 return registry;
30 }
31
32 void register_route(http::HttpMethod method, const std::string& path, const RouteMetadata& meta);
33
34 // Register a JSON schema (e.g. for a User object)
35 void register_schema(const std::string& name, const std::string& json_schema_body);
36
37 std::string generate_swagger_json(const std::string& title, const std::string& version) const;
38
39private:
40 struct EndpointMap {
41 std::map<http::HttpMethod, RouteMetadata> methods;
42 };
43
44 // path -> endpoints
45 std::map<std::string, EndpointMap> paths_;
46
47 // schema_name -> schema_json_body
48 std::unordered_map<std::string, std::string> schemas_;
49 mutable std::mutex mutex_;
50
51 std::string method_to_string(http::HttpMethod method) const;
52 std::string escape_json(const std::string& s) const;
53};
54
55} // namespace openapi
Definition OpenApi.hpp:20
void register_schema(const std::string &name, const std::string &json_schema_body)
void register_route(http::HttpMethod method, const std::string &path, const RouteMetadata &meta)
std::string generate_swagger_json(const std::string &title, const std::string &version) const
OpenApiRegistry()=default
Each App (root Router) has its own registry; see App::openapi().
std::mutex mutex_
Definition OpenApi.hpp:49
std::string escape_json(const std::string &s) const
std::map< std::string, EndpointMap > paths_
Definition OpenApi.hpp:45
std::string method_to_string(http::HttpMethod method) const
static OpenApiRegistry & instance()
Definition OpenApi.hpp:27
std::unordered_map< std::string, std::string > schemas_
Definition OpenApi.hpp:48
HttpMethod
Represents standard HTTP methods.
Definition HttpRequest.hpp:28
Definition legacy_namespaces.hpp:22
std::map< http::HttpMethod, RouteMetadata > methods
Definition OpenApi.hpp:41
Definition OpenApi.hpp:12
std::unordered_map< int, std::string > response_schemas
Definition OpenApi.hpp:17
std::string summary
Definition OpenApi.hpp:13
std::string request_body_schema
Definition OpenApi.hpp:16
std::vector< std::string > tags
Definition OpenApi.hpp:15
std::string description
Definition OpenApi.hpp:14