@antelopejs/interface-api

HTTP和WebSocket API的羚羊JS接口. 您使用装饰器声明控制器和路由, 而执行接口的模块为它们服务 .

部分 羚羊JS用于 羚羊JS 隐形物,用于您的 PostgreSQL 、 MongoDB 或 RethinkDB 数据库的开源后台.

它提供的东西

• Controller 财务报告和审定财务报表 PartialController 基道下的组路线,并有巢 extend。 。 。 .
• @Get, (中文(简体) ), @Post, (中文(简体) ), @Put, (中文(简体) ), @Delete,以及 @Route 将方法映射到终点. @Prefix, (中文(简体) ), @Postfix,以及 @Monitor 在他们之前或之后运行.
• @Parameter, (中文(简体) ), @MultiParameter, (中文(简体) ), @JSONBody, (中文(简体) ), @RawBody, (中文(简体) ), @BodyStream, (中文(简体) ), @Context, (中文(简体) ), @Result,以及 @WriteStream 将请求数据注入处理器参数. @Transform 在处理器收到前更改一个值.
• HTTPResult 设定响应状态、标题和正文。 身体是个 HTTPBody,该字符串或值 JSON.stringify 写作JSON.
• @WebsocketHandler 财务报告和审定财务报表 @Connection 在同一控制器上处理 WebSocket 连接.

执行情况

安装

将接口添加到宣布路线的模块中 :

pnpm add @antelopejs/interface-api

然后在项目中添加一个执行:

ajs project modules add @antelopejs/api

快开始

import {
  Controller,
  Get,
  HTTPResult,
  JSONBody,
  Parameter,
  Post,
} from "@antelopejs/interface-api";

export class BookController extends Controller("/books") {
  @Get(":id")
  async getBook(@Parameter("id") id: string) {
    return new HTTPResult(200, { id });
  }

  @Post("")
  async createBook(@JSONBody() body: { title: string }) {
    return new HTTPResult(201, body);
  }
}

装饰者在 JavaScript 定义类时对路由进行注册. @antelopejs/api 服务 GET /books/:id 财务报告和审定财务报表 POST /books。 。 。 .

文档

• 导言
• 主计长和路线登记
• HTTP 处理和操作
• 参数

兼容性

模块宣布此对等依赖 :

捐款

读取 捐款额 在你打开拉动请求之前。 当地检查为:

pnpm install
pnpm run checks

许可证

阿帕奇 - 2.0