From 3b500c71ec96feecc5f4fc238dffe3983d1b7dce Mon Sep 17 00:00:00 2001
From: tone <3341154833@qq.com>
Date: Wed, 25 Sep 2024 01:25:03 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E4=B8=AD=E9=97=B4=E4=BB=B6?=
 =?UTF-8?q?=E6=B3=A8=E9=87=8A=EF=BC=8C=E4=BC=98=E5=8C=96APILoader=E6=97=A5?=
 =?UTF-8?q?=E5=BF=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/lib/API/APILoader.ts                | 4 ++--
 src/lib/APIMiddleware/MountIP.ts        | 1 +
 src/lib/APIMiddleware/MountUserAgent.ts | 1 +
 src/lib/APIMiddleware/Unbind.ts         | 2 ++
 4 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/lib/API/APILoader.ts b/src/lib/API/APILoader.ts
index 5c372f6..cc05b5a 100644
--- a/src/lib/API/APILoader.ts
+++ b/src/lib/API/APILoader.ts
@@ -25,10 +25,10 @@ class APILoader {
                 try {
                     await func(req, res, next);
                 } catch (error) {
-                    this.logger.error(`[${instance.method}][${instance.path}][API Middleware Function: ${func.name}]: ${error}`);
+                    this.logger.error(`[${instance.method}][${instance.path}][Middleware Function: ${func.name}]: ${error}`);
                 }
             });
-            this.logger.info(`[${instance.method}][${instance.path}][API Middleware Function: ${func.name}] is enabled`);
+            this.logger.info(`[${instance.method}][${instance.path}][Middleware Function: ${func.name}] is enabled`);
         }
 
         // handle request
diff --git a/src/lib/APIMiddleware/MountIP.ts b/src/lib/APIMiddleware/MountIP.ts
index f4c185e..7b1c815 100644
--- a/src/lib/APIMiddleware/MountIP.ts
+++ b/src/lib/APIMiddleware/MountIP.ts
@@ -2,6 +2,7 @@ import { Request, Response, NextFunction } from "express"
 import Logger from "@lib/Logger/Logger";
 const logger = new Logger('API', 'Middleware', 'MountIP');
 
+// 挂载IP，将请求的ip地址挂载到data._ip属性下
 let MountIP = (req: Request, res: Response, next: NextFunction) => {
     let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip;
     if (ip == undefined || ip.length <= 0) {
diff --git a/src/lib/APIMiddleware/MountUserAgent.ts b/src/lib/APIMiddleware/MountUserAgent.ts
index 5262716..f4d3098 100644
--- a/src/lib/APIMiddleware/MountUserAgent.ts
+++ b/src/lib/APIMiddleware/MountUserAgent.ts
@@ -2,6 +2,7 @@ import { Request, Response, NextFunction } from "express"
 import Logger from "@lib/Logger/Logger";
 const logger = new Logger('API', 'Middleware', 'MountUserAgent')
 
+// 挂载用户代理，将请求的请求代理挂载到data._userAgent属性下
 let MountUserAgent = (req: Request, res: Response, next: NextFunction) => {
     req.body._userAgent = req.headers['user-agent'];
     logger.info(`[${req.method}][${req.url.split('?')[0]}] User agent parsed successfully: ${req.body._userAgent}`);
diff --git a/src/lib/APIMiddleware/Unbind.ts b/src/lib/APIMiddleware/Unbind.ts
index 7427071..6791349 100644
--- a/src/lib/APIMiddleware/Unbind.ts
+++ b/src/lib/APIMiddleware/Unbind.ts
@@ -1,6 +1,8 @@
 import { Request, Response, NextFunction } from "express";
 import Logger from "@lib/Logger/Logger";
 const logger = new Logger('API', 'Middleware', "Unbind");
+
+// 解绑接口，用于生产环境应用屏蔽某些不建议启用的API
 const Unbind = (req: Request, res: Response, next: NextFunction) => {
     let ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress || req.ip;
     logger.warn(`API[${req.method}][${req.url.split('?')[0]}] requested an unbound endpoint [${ip}]`);