qyani-web 1.0.6 → 1.0.8

package/README.md

@@ -1,14 +1,99 @@
+# 镜像地址
+[国内镜像](https://registry.npmmirror.com/)
+```shell
+npm config set registry https://registry.npmmirror.com
+```
 
-### 镜像地址
+# 快速开始
+**1.安装NodeJs环境**  
+[NodeJs下载](https://nodejs.org/en/download/)  
+**2.创建项目**
 ```shell
-https://registry.npmmirror.com/
+mkdir my-project
+cd my-project
+npm init -y
+npm install qyani-web
 ```
-### 快速开始
-1. 安装TypeScript
+**3.启动demo**
 ```shell
-npm install typescript 
+node node_modules/qyani-web/demo/index.js
+```
+
+# 项目介绍
+qyani-web是一个基于NodeJs的web开发框架,具有**可拓展**,**模块化**,**简单易用**的特点
+
+## 核心类
+```typescript
+/**
+ * 核心类
+ * @class WebApp
+ */
+const app=new WebApp();
+
+const groupRoute=new GroupRoute();
 ```
-2. 配置tsconfig.json
+## 编写中间件
+
+```typescript
+import http from "http";
+
+/**
+ * 中间件
+ * @interface MiddleWare
+ * @param {http.IncomingMessage} req
+ * @param {http.ServerResponse} res
+ * @returns {boolean} 返回true则继续执行下一个中间件,返回true则结束请求
+ */
+type MiddleWare = (req: http.IncomingMessage, res: http.ServerResponse)=>boolean|Promise<boolean>;
+```
+
+## 注册中间件
+```typescript
+app.beforeRequest(middelware)
+groupRoute.beforeRequest(middelware)
+app.afterRequest(middelware)
+groupRoute.afterRequest(middelware)
+```
+## 注册路由
+```typescript
+type handler = (req: http.IncomingMessage, res: http.ServerResponse) => void|boolean|Promise<void|boolean>;
+function get(url:string, handler:Handler,beforeRequest:MiddleWare[],afterRequest:MiddleWare[]){}
+function post(url:string, handler:Handler,beforeRequest:MiddleWare[],afterRequest:MiddleWare[]){}
+function put(url:string, handler:Handler,beforeRequest:MiddleWare[],afterRequest:MiddleWare[]){}
+/*.....*/
+/**
+ * 注册分组路由
+ */
+app.registerGroupRoute(groupRoute);
+```
+
+## 启动服务
+```typescript
+app.listen(port=80,callBack=()=>{});
+```
+
+## 已有中间件
+1. **CorsMiddleware**
+2. **LogMiddleware**
+3. **StaticMiddleware**
+4. **BodyParserMiddleware**
+5. **validateMiddleware**
+
+
+## 项目结构
 ```shell
-npx tsc --init
-```
+qyani-web/
+├── demo/
+├── ├── index.js  /** demo入口文件 **/
+├── dist/
+├── ├── lib/
+├── ├── ├── middleware/
+├── ├── ├── ├── body-parser.js /** body解析中间件 **/
+├── ├── ├── ├── cors.js /** 跨域中间件 **/
+├── ├── ├── ├── logger.js /** 日志中间件 **/
+├── ├── ├── ├── static-resources.js /** 静态资源中间件 **/
+├── ├── ├── ├── validate.js /** 参数验证中间件 **/
+├── ├── ├── groupRoute.js /** 分组路由 **/
+├── ├── index.js  /** webApp入口文件 **/
+```
+

package/dist/index.js

@@ -1,7 +1,7 @@
 // app.js
 import https from 'https';
 import url from 'url';
-import GroupRoute from "./lib/group-route";
+import GroupRoute from "./lib/group-route.js";
 import * as http from "http";
 export { GroupRoute };
 export default class WebApp {
@@ -225,6 +225,7 @@ export default class WebApp {
             server = http.createServer(this._handleRequest.bind(this));
         }
         server.listen(port, callback);
+        console.log(`Server run on ${protocol}://127.0.0.1:${port}`);
     }
     /**
      * 内部方法，用于注册路由

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qyani-web",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Backend for the app",
   "main": "./dist/index.js",
   "author": "Qianrenni",