@ aerokit/ sdk (英语)

以统一的TypeScript SDK为现代云平台,加快您的应用和集成开发.

概览

@aerokit/sdk 页:1 模块, (中文(简体) ), 服务器侧类型Script 为开发轻量级而设计的运行时间 API 应用、自动化脚本和跨云层或精密环境的扩展.

核心特征

• 类型脚本第一 API – 丰富的类型定义和IDE自动补全,用于生产,安全的脚本.
• 统一平台模式 – HTTP, I/O, Database, Filesystem, Security, Jobs, and Message 的常见抽象.
• 内置装饰器 - 简化发展方式 @Controller, (中文(简体) ), @Entity, (中文(简体) ), @Scheduled, (中文(简体) ), @Component, (中文(简体) ), @Injected, (中文(简体) ), 还有更多.
• 无接缝依赖性注射 – 连接模块化业务逻辑的轻量级IoC机制.
• 可累积持久性 - 通过SQL和NoSQL工作 sdk/sdk/db API (英语).
• 企业准备的 HTTP 层 - 与 sdk/sdk/http。 。 。 .
• 背景任务和听众 - 使用 sdk/sdk/job 或事件驱动的听众 sdk/component。 。 。 .
• 广泛运行时间 - 在不重新部署的情况下动态部署、扩展和运行模块.

示例

CountryEntity.ts

import { Entity, Table, Id, Generated, Column, Documentation } from "@aerokit/sdk/db";

@Entity("CountryEntity")
@Table("SAMPLE_COUNTRY")
@Documentation("Sample Country Entity")
export class CountryEntity {

    @Id()
    @Generated("sequence")
    @Column({ name: "COUNTRY_ID", type: "long" })
    @Documentation("My Id")
    public Id?: number;

    @Column({ name: "COUNTRY_NAME", type: "string" })
    @Documentation("My Name")
    public Name?: string;

    @Column({ name: "COUNTRY_CODE2", type: "string" })
    public Code2?: string;

    @Column({ name: "COUNTRY_CODE3", type: "string" })
    public Code3?: string;

    @Column({ name: "COUNTRY_NUMERIC", type: "string" })
    public Numeric?: string;

}

CountryRepository.ts

import { Repository, EntityConstructor } from "@aerokit/sdk/db";
import { Component } from "@aerokit/sdk/component";
import { CountryEntity } from "./CountryEntity";

@Component('CountryRepository')
export class CountryRepository extends Repository<CountryEntity> {

    constructor() {
        super((CountryEntity as EntityConstructor));
    }

}

CountryRepository;

CountryController.ts

import { Controller, Get, Documentation } from "@aerokit/sdk/http"
import { HttpUtils } from "@aerokit/sdk/http/utils";
import { Options } from "@aerokit/sdk/db";
import { Injected, Inject } from "@aerokit/sdk/component";
import { CountryEntity } from "./CountryEntity";
import { CountryRepository } from "./CountryRepository";

@Controller
@Documentation("Sample Country Controller")
@Injected()
class CountryController {

    @Inject('CountryRepository')
    private readonly repository!: CountryRepository;

    @Get("/")
    @Documentation("Sample Get All Countries")
    public getAll(): CountryEntity[] {
        try {
            const options: Options = {limit: 20, offset: 0};
            return this.repository.findAll(options);
        } catch (error: any) {
            HttpUtils.sendInternalServerError(error.message);
        }
        return [];
    }

}

SDK 模块

使用大小写

• API-第一业务逻辑用于内部或客户应用.
• 企业系统之间的轻量级整合.
• 自动化脚本(计划或事件驱动).
• 自定义模块运行时间中的平台扩展.

哲学

@aerokit 遵循一个代码配置哲学——而不是XML或JSON描述符,您定义服务, ,并使用装饰器直接在 TypeScript 中工作. 这使得你的代码可以自我记录,可以测试,并跨环境可移植.

开始

npm install @aerokit/sdk

然后只导入您需要的东西 :

import { Request, Response } from "@aerokit/sdk/http";
import { Entity, Column } from "@aerokit/sdk/db";