fix: swagger getting configuration from config file (#1803)

namchuai · web-flow · commit c9f15a203d86 · 2024-12-17T13:49:36.000+07:00
diff --git a/docs/static/openapi/cortex.json b/docs/static/openapi/cortex.json
@@ -3092,7 +3092,7 @@
                       "items": {
                         "type": "string"
                       },
-                      "example": ["http://localhost:39281", "https://cortex.so"]
+                      "example": ["http://127.0.0.1:39281", "https://cortex.so"]
                     },
                     "cors": {
                       "type": "boolean",
@@ -3139,7 +3139,7 @@
                 },
                 "example": {
                   "allowed_origins": [
-                    "http://localhost:39281",
+                    "http://127.0.0.1:39281",
                     "https://cortex.so"
                   ],
                   "cors": false,
@@ -3180,7 +3180,7 @@
                       "type": "string"
                     },
                     "description": "List of allowed origins.",
-                    "example": ["http://localhost:39281", "https://cortex.so"]
+                    "example": ["http://127.0.0.1:39281", "https://cortex.so"]
                   },
                   "proxy_username": {
                     "type": "string",
@@ -3249,7 +3249,7 @@
                             "type": "string"
                           },
                           "example": [
-                            "http://localhost:39281",
+                            "http://127.0.0.1:39281",
                             "https://cortex.so"
                           ]
                         },
diff --git a/engine/controllers/swagger.cc b/engine/controllers/swagger.cc
@@ -2,30 +2,17 @@
 #include "cortex_openapi.h"
 #include "utils/cortex_utils.h"
 
-constexpr auto ScalarUi = R"(
-<!doctype html>
-<html>
-  <head>
-    <title>Cortex API Reference</title>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1" />
-  </head>
-  <body>
-    <!-- Need a Custom Header? Check out this example https://codepen.io/scalarorg/pen/VwOXqam -->
-    <script
-      id="api-reference"
-      data-url="/openapi.json"></script>
-    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
-  </body>
-</html>
-)";
-
-Json::Value SwaggerController::generateOpenAPISpec() {
+Json::Value SwaggerController::GenerateOpenApiSpec() const {
   Json::Value root;
   Json::Reader reader;
   reader.parse(CortexOpenApi::GetOpenApiJson(), root);
+
+  Json::Value server_url;
+  server_url["url"] = "http://" + host_ + ":" + port_;
+  Json::Value resp_data(Json::arrayValue);
+  resp_data.append(server_url);
+
+  root["servers"] = resp_data;
   return root;
 }
 
@@ -41,7 +28,7 @@ void SwaggerController::serveSwaggerUI(
 void SwaggerController::serveOpenAPISpec(
     const drogon::HttpRequestPtr& req,
     std::function<void(const drogon::HttpResponsePtr&)>&& callback) const {
-  Json::Value spec = generateOpenAPISpec();
+  auto spec = GenerateOpenApiSpec();
   auto resp = cortex_utils::CreateCortexHttpJsonResponse(spec);
   callback(resp);
 }
diff --git a/engine/controllers/swagger.h b/engine/controllers/swagger.h
@@ -5,13 +5,38 @@
 
 using namespace drogon;
 
-class SwaggerController : public drogon::HttpController<SwaggerController> {
+class SwaggerController
+    : public drogon::HttpController<SwaggerController, false> {
+
+  constexpr static auto ScalarUi = R"(
+<!doctype html>
+<html>
+  <head>
+    <title>Cortex API Reference</title>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1" />
+  </head>
+  <body>
+    <!-- Need a Custom Header? Check out this example https://codepen.io/scalarorg/pen/VwOXqam -->
+    <script
+      id="api-reference"
+      data-url="/openapi.json"></script>
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+  </body>
+</html>
+)";
+
  public:
   METHOD_LIST_BEGIN
   ADD_METHOD_TO(SwaggerController::serveSwaggerUI, "/", Get);
   ADD_METHOD_TO(SwaggerController::serveOpenAPISpec, "/openapi.json", Get);
   METHOD_LIST_END
 
+  explicit SwaggerController(const std::string& host, const std::string& port)
+      : host_{host}, port_{port} {};
+
   void serveSwaggerUI(
       const drogon::HttpRequestPtr& req,
       std::function<void(const drogon::HttpResponsePtr&)>&& callback) const;
@@ -21,6 +46,8 @@ class SwaggerController : public drogon::HttpController<SwaggerController> {
       std::function<void(const drogon::HttpResponsePtr&)>&& callback) const;
 
  private:
-  static const std::string swaggerUIHTML;
-  static Json::Value generateOpenAPISpec();
-};
+  std::string host_;
+  std::string port_;
+
+  Json::Value GenerateOpenApiSpec() const;
+};
diff --git a/engine/main.cc b/engine/main.cc
@@ -11,6 +11,7 @@
 #include "controllers/models.h"
 #include "controllers/process_manager.h"
 #include "controllers/server.h"
+#include "controllers/swagger.h"
 #include "controllers/threads.h"
 #include "database/database.h"
 #include "migrations/migration_manager.h"
@@ -155,6 +156,8 @@ void RunServer(std::optional<int> port, bool ignore_cout) {
   file_watcher_srv->start();
 
   // initialize custom controllers
+  auto swagger_ctl = std::make_shared<SwaggerController>(config.apiServerHost,
+                                                         config.apiServerPort);
   auto file_ctl = std::make_shared<Files>(file_srv, message_srv);
   auto assistant_ctl = std::make_shared<Assistants>(assistant_srv);
   auto thread_ctl = std::make_shared<Threads>(thread_srv, message_srv);
@@ -169,6 +172,7 @@ void RunServer(std::optional<int> port, bool ignore_cout) {
       std::make_shared<inferences::server>(inference_svc, engine_service);
   auto config_ctl = std::make_shared<Configs>(config_service);
 
+  drogon::app().registerController(swagger_ctl);
   drogon::app().registerController(file_ctl);
   drogon::app().registerController(assistant_ctl);
   drogon::app().registerController(thread_ctl);
