endpoint_registry.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_OPENAPI_ENDPOINT_REGISTRY_HPP
#define ORES_HTTP_OPENAPI_ENDPOINT_REGISTRY_HPP
 
#include <string>
#include <vector>
#include "ores.http.api/domain/route.hpp"
#include "ores.logging/make_logger.hpp"
 
namespace ores::http::openapi {
 
struct api_info final {
    std::string title = "OreStudio HTTP API";
    std::string description = "RESTful API for OreStudio";
    std::string version = "1.0.0";
    std::string contact_name;
    std::string contact_email;
    std::string license_name = "GPL-3.0";
    std::string license_url;
};
 
struct server_info final {
    std::string url;
    std::string description;
};
 
class endpoint_registry final {
public:
    endpoint_registry();
 
    void set_info(const api_info& info);
 
    void add_server(const server_info& server);
 
    void register_route(const domain::route& route);
 
    std::string generate_openapi_json() const;
 
    std::string generate_swagger_ui_html(const std::string& spec_url = "/openapi.json") const;
 
private:
    inline static std::string_view logger_name = "ores.http.openapi.endpoint_registry";
 
    static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
    std::string method_to_string(domain::http_method method) const;
 
    api_info info_;
    std::vector<server_info> servers_;
    std::vector<domain::route> routes_;
};
 
}
 
#endif