route.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_HTTP_DOMAIN_ROUTE_HPP
#define ORES_HTTP_DOMAIN_ROUTE_HPP
 
#include <regex>
#include <string>
#include <vector>
#include <optional>
#include <functional>
#include <boost/asio/awaitable.hpp>
#include "ores.http.api/domain/http_method.hpp"
#include "ores.http.api/domain/http_request.hpp"
#include "ores.http.api/domain/http_response.hpp"
 
namespace ores::http::domain {
 
struct query_param final {
    std::string name;
    std::string type = "string";
    std::string format;           // Optional format (e.g., uuid, date)
    bool required = false;
    std::string description;
    std::optional<std::string> default_value;
};
 
struct request_body_schema final {
    std::string content_type = "application/json";
    bool required = true;
    std::string json_schema;   // JSON schema from rfl::json::to_schema<T>()
    std::string example_json;  // Example JSON from generator
};
 
struct response_schema final {
    std::string status_code = "200";
    std::string description = "Successful response";
    std::string content_type = "application/json";
    std::string json_schema;   // JSON schema from rfl::json::to_schema<T>()
    std::string example_json;  // Example JSON from generator
};
 
using request_handler = std::function<
    boost::asio::awaitable<http_response>(const http_request&)>;
 
struct route final {
    http_method method;
 
    std::string pattern;
 
    std::regex regex;
 
    std::vector<std::string> param_names;
 
    request_handler handler;
 
    bool requires_auth = false;
 
    std::vector<std::string> required_roles;
 
    std::string summary;
 
    std::string description;
 
    std::vector<std::string> tags;
 
    std::vector<query_param> query_params;
 
    std::optional<request_body_schema> body_schema;
 
    std::optional<response_schema> success_response_schema;
 
    bool match(const std::string& path,
        std::unordered_map<std::string, std::string>& path_params) const;
};
 
}
 
#endif