koa-ts-core 0.0.8-beta.2 → 0.0.8-beta.3

package/README.md

@@ -96,6 +96,59 @@ class User {
 export default User;
 ```
 
+#### 支持 REST 风格定义
+
+```typescript
+import Koa from "koa";
+import { Router, successRsp } from "koa-ts-core";
+
+class Test {
+  @Router()
+  async get_(ctx: Koa.Context) {
+    successRsp({
+      data: "get request",
+    });
+  }
+
+  @Router()
+  async post(ctx: Koa.Context) {
+    successRsp({
+      data: "post request",
+    });
+  }
+
+  @Router()
+  async put(ctx: Koa.Context) {
+    successRsp({
+      data: "put request",
+    });
+  }
+
+  @Router()
+  async delete(ctx: Koa.Context) {
+    successRsp({
+      data: "delete request",
+    });
+  }
+
+  @Router()
+  async patch(ctx: Koa.Context) {
+    successRsp({
+      data: "patch request",
+    });
+  }
+
+  @Router()
+  async options(ctx: Koa.Context) {
+    successRsp({
+      data: "options request",
+    });
+  }
+}
+
+export default Test;
+```
+
 #### 装饰器实现
 
 `@Router`和`@AuthRouter`装饰器本质是基于[koa-router](https://github.com/koajs/router)进行封装
@@ -220,6 +273,9 @@ export default class Test {
 
 控制器的父级目录路径，用于辅助 core 查找控制器所在目录
 
+**例如运行在 docker 项目中的目录为 `/app/build/controller`, 则 `CONTROLLER_DIR_PATH` 值填写为 `build`**
+
 ```js
+// core查找控制器目录实现
 resolve(process.cwd(), process.env.CONTROLLER_DIR_PATH ?? "");
 ```