@com75271-assist/build-api 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,1354 @@
+declare interface ApiDoc {
+    basePath: string;
+    definitions: Data<Model>;
+    info: ApiInfo;
+    paths: ApiPath;
+    swagger: string;
+    tags: ApiTag[];
+}
+
+declare interface ApiInfo {
+    description: string;
+    title: string;
+    version: string;
+}
+
+declare interface ApiOperation {
+    operationId: string;
+    parameters?: Parameter[];
+    produces: string[];
+    responses: Data<Response_2>;
+    summary: string;
+    tags: string[];
+}
+
+declare interface ApiOperationResolveApiName {
+    map?: CountMap_2;
+    countName?: (name: string) => string;
+}
+
+declare interface ApiOperationWrapper {
+    serviceName: string;
+    operationName: string;
+    package: string;
+    url: string;
+    method: string;
+    apiOperation: ApiOperation;
+    responseTypeResolver?: (apiOperation: ApiOperation) => string;
+    modelPoolMap: Map<string, TsModel>;
+    paramPackageName?: string;
+}
+
+declare interface ApiPath {
+    [prop: string]: Data<ApiOperation>;
+}
+
+declare interface ApiTag {
+    name: string;
+    description: string;
+}
+
+declare interface Builder {
+    /**
+     * 生成
+     */
+    build(): void;
+}
+
+/**
+ * 根据swagger2定义生成javascript接口文档
+ * @param config
+ */
+export declare function buildSwagger2Js(config: NjkJsSwagger2BuilderConfig): void;
+
+export declare const buildSwagger2Ts: typeof buildSwaggerTs;
+
+/**
+ * 根据swagger3定义生成typescript接口文档
+ * @param config
+ */
+export declare function buildSwagger3Ts(config: NjkTsSwagger3BuilderConfig): void;
+
+/**
+ * 根据swagger2定义生成typescript接口文档
+ * @param config
+ */
+export declare function buildSwaggerTs(config: NjkTsSwagger2BuilderConfig): void;
+
+declare class CountMap {
+    private map;
+    count(name: string): number;
+}
+
+declare class CountMap_2 {
+    private map = new Map<string, number>()
+
+    public count(name: string) {
+        const count = (this.map.get(name) || 0) + 1
+        this.map.set(name, count)
+        return count
+    }
+}
+
+declare interface Data<T> {
+    [prop: string]: T;
+}
+
+declare interface EnumItem {
+    name: string;
+    label: string;
+}
+
+declare interface EnumModelProperty extends SampleModelProperty {
+    type: 'string';
+    enum: string[];
+    enumList: EnumItem[];
+    enumSimpleTypeName: string;
+    enumTypeName: string;
+}
+
+declare interface EnumModelPropertyWrapper extends ModelPropertyWrapper {
+    package: string;
+    modelProperty: EnumModelProperty;
+}
+
+declare interface Model {
+    required?: string[];
+    title: string;
+    type: string;
+}
+
+declare interface ModelProperty {
+    allowEmptyValue?: boolean;
+    description?: string;
+    example?: unknown;
+}
+
+declare interface ModelPropertyWrapper {
+    name: string;
+    modelProperty: ModelProperty;
+    model: Model | null;
+}
+
+declare interface ModelWrapper {
+    package: string;
+    name: string;
+    model: Model;
+    modelPackageName?: string;
+    enumPackageName?: string;
+}
+
+export declare enum NameStyle {
+    /**
+     * 小驼峰
+     */
+    CAMEL_CASE = 0,
+    /**
+     * 大驼峰
+     */
+    UPPER_CAMEL_CASE = 1,
+    /**
+     * 帕斯卡命名，等于大驼峰
+     */
+    PASCAL = 2,
+    /**
+     * 下划线
+     */
+    UNDER_SCORE_CASE = 3,
+    /**
+     * 短横线
+     */
+    KEBAB_CASE = 4
+}
+
+declare interface NjkApi {
+    /**
+     * 依赖，import xx from xx
+     */
+    dependencies: NjkDependency[];
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 描述
+     */
+    description: string;
+    /**
+     * api地址
+     */
+    url: string;
+    /**
+     * api method
+     */
+    method: string;
+    /**
+     * 响应类型
+     */
+    responseType: string;
+    /**
+     * 参数
+     */
+    parameter?: NjkApiParameter;
+    /**
+     * 响应
+     */
+    response: NjkApiResponse;
+}
+
+declare interface NjkApiParameter {
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 参数防止位置
+     */
+    parameterInBody?: boolean;
+}
+
+declare interface NjkApiResponse {
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 泛型名称
+     */
+    genericityName?: string;
+    /**
+     * 是否数组
+     */
+    isArray?: boolean;
+}
+
+declare abstract class NjkBuilder implements Builder {
+    protected njkBuilderConfig: NjkBuilderConfig;
+    protected template: NjkTemplate;
+    /**
+     * 需要生成的 Models
+     * @protected
+     */
+    protected models: NjkModel[];
+    /**
+     * 需要生成的 EnumModels
+     * @protected
+     */
+    protected enumModels: NjkEnumModel[];
+    /**
+     * 需要生成的 Services
+     * @protected
+     */
+    protected services: NjkService[];
+    constructor(njkBuilderConfig: NjkBuilderConfig, template: NjkTemplate);
+    /**
+     * 执行生成器
+     */
+    build(): void;
+    /**
+     * 删除输出目录
+     * @protected
+     */
+    removeOutputDir(): void;
+    /**
+     * 创建模版
+     * @protected
+     */
+    buildTemplate(): Promise<void>;
+    /**
+     * 重置models
+     * @param models
+     * @protected
+     */
+    protected setModels(models: NjkModel[]): void;
+    /**
+     * 重置enumModels
+     * @param enumModels
+     * @protected
+     */
+    protected setEnumModels(enumModels: NjkEnumModel[]): void;
+    /**
+     * 重置services
+     * @param services
+     * @protected
+     */
+    protected setServices(services: NjkService[]): void;
+    /**
+     * 创建model模版
+     * @param models
+     * @protected
+     */
+    protected buildModelTemplate(models: NjkModel[]): Promise<void>;
+    /**
+     * 创建enumModel模版
+     * @param enumModels
+     * @protected
+     */
+    protected buildEnumModelTemplate(enumModels: NjkEnumModel[]): Promise<void>;
+    /**
+     * 创建service模版
+     * @param services
+     * @protected
+     */
+    protected buildServiceTemplate(services: NjkService[]): Promise<void>;
+    /**
+     * models去重
+     * @param models
+     * @protected
+     */
+    protected distinctModels<T extends NjkModel>(models: T[]): T[];
+    /**
+     * 处理文件名，子类可复写该方法实现文件扩展名
+     * @param packagePath
+     * @param name
+     * @protected
+     */
+    protected resolveFileName(packagePath: string, name: string): string;
+    /**
+     * 处理文件后缀名，方便子类复写
+     * @param name
+     * @protected
+     */
+    protected resolveFileNameExt(name: string): string;
+}
+
+declare interface NjkBuilderConfig {
+    /**
+     * Service集合
+     */
+    services?: NjkService[];
+    /**
+     * Model集合
+     */
+    models?: NjkModel[];
+    /**
+     * EnumModel集合
+     */
+    enumModels?: NjkEnumModel[];
+    /**
+     * 输出目录
+     */
+    outputDir: string;
+    /**
+     * 文件命名风格
+     */
+    fileNameStyle?: NameStyle;
+    /**
+     * 包名命名风格
+     */
+    packageNameStyle?: NameStyle;
+}
+
+declare interface NjkDependency {
+    /**
+     * 依赖的 Model
+     */
+    model: NjkModel;
+    /**
+     * package引用路径
+     */
+    package: string;
+    /**
+     * model的别名
+     */
+    aliasName?: string;
+}
+
+declare interface NjkEnumItem {
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 值
+     */
+    value: string;
+    /**
+     * 描述
+     */
+    description: string;
+}
+
+declare interface NjkEnumModel extends NjkModel {
+    /**
+     * 枚举数据
+     */
+    enumItems: NjkEnumItem[];
+    /**
+     * 描述
+     */
+    description: string;
+}
+
+export declare class NjkJsSwagger2Builder extends NjkTsSwagger2Builder {
+    protected config: NjkJsSwagger2BuilderConfig;
+    constructor(config: NjkJsSwagger2BuilderConfig);
+    protected resolveFileNameExt(name: string): string;
+}
+
+declare interface NjkJsSwagger2BuilderConfig extends NjkTsSwagger2BuilderConfig {
+}
+
+declare interface NjkModel {
+    /**
+     * 包名
+     */
+    package: string;
+    /**
+     * 类名
+     */
+    name: string;
+    /**
+     * 文件名，默认等于name
+     */
+    fileName?: string;
+    /**
+     * 依赖，import xx from xx
+     */
+    dependencies: NjkDependency[];
+    /**
+     * 属性
+     */
+    properties: NjkModelProperty[];
+    /**
+     * 继承父类名称
+     */
+    parentName?: string;
+}
+
+declare interface NjkModelProperty {
+    /**
+     * 属性名
+     */
+    name: string;
+    /**
+     * 是否必须
+     */
+    required: boolean;
+    /**
+     * 类型名称
+     */
+    typeName: string;
+    /**
+     * 是否为数组
+     */
+    isArray: boolean;
+    /**
+     * 是否为引用类型
+     */
+    isRef: boolean;
+    /**
+     * 描述
+     */
+    description: string;
+}
+
+declare interface NjkService {
+    /**
+     * 包名
+     */
+    package: string;
+    /**
+     * 类名
+     */
+    name: string;
+    /**
+     * 文件名，默认等于name
+     */
+    fileName?: string;
+    /**
+     * 依赖，import xx from xx
+     */
+    dependencies: NjkDependency[];
+    /**
+     * api
+     */
+    apis: NjkApi[];
+}
+
+declare class NjkTemplate {
+    protected config: NjkTemplateConfig;
+    /**
+     * Model 的模版内容
+     *
+     * @protected
+     *
+     * @memberOf NjkTemplate
+     */
+    protected modelTemplateContent: string;
+    /**
+     * EnumModel 的模版内容
+     *
+     * @protected
+     *
+     * @memberOf NjkTemplate
+     */
+    protected enumModelTemplateContent: string;
+    /**
+     * Service 的模版内容
+     *
+     * @protected
+     *
+     * @memberOf NjkTemplate
+     */
+    protected serviceTemplateContent: string;
+    constructor(config: NjkTemplateConfig);
+    /**
+     * 创建 Model 模版
+     *
+     * @param {object} context
+     * @param {string} newFileAbsPath
+     *
+     * @memberOf NjkTemplate
+     */
+    createModel(context: object, newFileAbsPath: string): Promise<void>;
+    /**
+     * 创建 EnumModel 模版
+     *
+     * @param {object} context
+     * @param {string} newFileAbsPath
+     *
+     * @memberOf NjkTemplate
+     */
+    createEnumModel(context: object, newFileAbsPath: string): Promise<void>;
+    /**
+     * 创建 Service 模版
+     *
+     * @param {object} context
+     * @param {string} newFileAbsPath
+     *
+     * @memberOf NjkTemplate
+     */
+    createService(context: object, newFileAbsPath: string): Promise<void>;
+    /**
+     * 创建模版
+     *
+     * @param {string} templateContent
+     * @param {object} context
+     * @param {string} newFileAbsPath
+     *
+     * @memberOf NjkTemplate
+     */
+    createTemplate(templateContent: string, context: object, newFileAbsPath: string): Promise<void>;
+    /**
+     * 模版上下文
+     *
+     * @protected
+     * @param {object} context
+     * @returns
+     *
+     * @memberOf NjkTemplate
+     */
+    protected getContext(context: object): {
+        utils: {
+            upperUnderline: (value: string) => string;
+            injectUrl: (url: string, data: object) => string;
+            feedLine: (str: string, replacer: string, len: number) => string;
+            feedEnumModel: (str: string, replacer: string) => string;
+        };
+    } & object;
+}
+
+declare interface NjkTemplateConfig {
+    /**
+     * model模版
+     */
+    modelTemplate?: string;
+    /**
+     * 枚举模版
+     */
+    enumModelTemplate?: string;
+    /**
+     * service模版
+     */
+    serviceTemplate?: string;
+    /**
+     * model context
+     */
+    modelContext?: Data<string>;
+    /**
+     * enumModel context
+     */
+    enumModelContext?: Data<string>;
+    /**
+     * service context
+     */
+    serviceContext?: Data<string>;
+}
+
+declare class NjkTsBuilder extends NjkBuilder {
+    static readonly defaultConfig: NjkTsBuilderConfig;
+    constructor(config: NjkTsBuilderConfig);
+    /**
+     * 合并service中的api
+     * @param services
+     * @protected
+     */
+    protected mergeServiceApis(services: TsService[]): TsService[];
+    /**
+     * 重整models的依赖关系
+     * @param models
+     * @param modelPoolMap
+     * @protected
+     */
+    protected reformModelDependencies(models: TsModel[], modelPoolMap: Map<string, TsModel>): TsModel[];
+    /**
+     * 返回ts后缀名
+     * @param name
+     * @protected
+     */
+    protected resolveFileNameExt(name: string): string;
+    /**
+     * 根据命名风格处理文件和导入路径
+     * @param options
+     * @protected
+     */
+    protected resolveNameStyle(options: {
+        models: TsModel[];
+        enumModels: TsEnumModel[];
+        services: TsService[];
+    }): void;
+}
+
+declare interface NjkTsBuilderConfig {
+    template?: NjkTemplateConfig;
+    builder: NjkBuilderConfig;
+}
+
+export declare class NjkTsSwagger2Builder extends NjkTsBuilder {
+    protected config: NjkTsSwagger2BuilderConfig;
+    protected modelTranslator: Swagger2ModelTranslator;
+    protected enumModelTranslator: Swagger2EnumModelTranslator;
+    protected modelPropertyTranslator: Swagger2ModelPropertyTranslator;
+    protected parameterTranslator: Swagger2ParameterTranslator;
+    protected responseTranslator: Swagger2ResponseTranslator;
+    protected apiOperationTranslator: Swagger2ApiOperationTranslator;
+    protected genericityDependenciesTranslator: TsGenericityDependenciesTranslator;
+    protected swaggerService: SwaggerService;
+    protected packageDepth: number;
+    protected defaultSwaggerResourcePath: string;
+    protected defaultSwaggerDocumentPath: string;
+    constructor(config: NjkTsSwagger2BuilderConfig);
+    build(): void;
+    /**
+     * 构建Swagger2生成器
+     * @param resource
+     * @param doc
+     * @protected
+     */
+    protected buildSwagger2(resource: SwaggerResource, doc: ApiDoc): Promise<void>;
+    /**
+     * 创建Model
+     * @param doc
+     * @protected
+     */
+    protected buildSwagger2Models(doc: ApiDoc): {
+        models: TsModel[];
+        modelPoolMap: Map<string, TsModel>;
+        enumModels: TsEnumModel[];
+    };
+    /**
+     * 创建Service
+     * @param resource
+     * @param doc
+     * @param modelPoolMap
+     * @protected
+     */
+    protected buildSwagger2Services(resource: SwaggerResource, doc: ApiDoc, modelPoolMap: Map<string, TsModel>): TsService[];
+    /**
+     * 创建参数Model
+     * @param doc
+     * @param modelPoolMap
+     * @protected
+     */
+    protected buildSwagger2ParameterModels(doc: ApiDoc, modelPoolMap: Map<string, TsModel>): {
+        parameterModels: TsModel[];
+        enumModels: TsEnumModel[];
+    };
+    /**
+     * 计算出包的根目录，并更新到doc.basePath
+     * @param doc
+     * @protected
+     */
+    protected resolveBasePath(doc: ApiDoc): void;
+}
+
+declare interface NjkTsSwagger2BuilderConfig {
+    /**
+     * 模版配置
+     */
+    template?: NjkTemplateConfig;
+    /**
+     * 输出目录
+     */
+    outputDir?: string;
+    /**
+     * 作为package路径的层级深度，可选范围=[1, 9]，默认3
+     */
+    packageDepth?: number;
+    /**
+     * responseType解析器
+     * @param apiOperation
+     */
+    responseTypeResolver?: (apiOperation: ApiOperation) => string;
+    /**
+     * 文件命名风格
+     */
+    fileNameStyle?: NameStyle;
+    /**
+     * 包名命名风格
+     */
+    packageNameStyle?: NameStyle;
+    swagger: {
+        /**
+         * swagger域名
+         */
+        domain: string;
+        /**
+         * resourcePath请求路径，默认swagger2的路径
+         */
+        resourcePath?: string;
+        /**
+         * documentPath请求路径，默认swagger2的路径
+         */
+        documentPath?: string;
+        /**
+         * 过滤SwaggerResource，可选择只输出部分SwaggerResource的接口
+         */
+        resourceFilter?: (resource: SwaggerResource) => boolean;
+        /**
+         * SwaggerResource中过滤paths，更细粒度的根据path过滤
+         */
+        pathFilter?: (resource: SwaggerResource, url: string, method: string, apiOperation: ApiOperation) => boolean;
+    };
+    templateContext?: {
+        /**
+         * Model 模版上下文
+         */
+        model?: Data<any>;
+        /**
+         * EnumModel 模版上下文
+         */
+        enumModel?: Data<any>;
+        /**
+         * Service 模版上下文
+         */
+        service?: Data<any>;
+    };
+}
+
+export declare class NjkTsSwagger3Builder extends NjkTsBuilder {
+    protected config: NjkTsSwagger3BuilderConfig;
+    protected modelTranslator: Swagger3ModelTranslator;
+    protected modelPropertyTranslator: Swagger3ModelPropertyTranslator;
+    protected parameterTranslator: Swagger3ParameterTranslator;
+    protected requestBodyTranslator: Swagger3RequestBodyTranslator;
+    protected responseTranslator: Swagger3ResponseTranslator;
+    protected apiOperationTranslator: Swagger3ApiOperationTranslator;
+    protected genericityDependenciesTranslator: Swagger3TsGenericityDependenciesTranslator;
+    swaggerService: Swagger3Service;
+    protected packageDepth: number;
+    protected defaultSwaggerResourcePath: string;
+    protected defaultSwaggerDocumentPath: string;
+    constructor(config: NjkTsSwagger3BuilderConfig);
+    build(): void;
+    buildSwagger3(resource: Swagger3Resource, doc: Swagger3ApiDoc): Promise<void>;
+    buildSwagger3Models(doc: Swagger3ApiDoc, data: {
+        rootPackage: string;
+    }): {
+        models: TsModel[];
+        modelPoolMap: Map<string, TsModel>;
+        enumModels: TsEnumModel[];
+    };
+    buildSwagger3Services(resource: Swagger3Resource, doc: Swagger3ApiDoc, modelPoolMap: Map<string, TsModel>): TsService[];
+    /**
+     * 创建参数Model
+     * @param doc
+     * @param data
+     */
+    buildSwagger3ParameterModels(doc: Swagger3ApiDoc, data: {
+        rootPackage: string;
+        modelPoolMap: Map<string, TsModel>;
+    }): {
+        parameterModels: TsModel[];
+        enumModels: TsEnumModel[];
+    };
+    /**
+     * 计算出包的根目录，并更新到doc.basePath
+     * @param doc
+     */
+    resolveBasePath(doc: Swagger3ApiDoc): string;
+}
+
+declare interface NjkTsSwagger3BuilderConfig extends NjkTsSwagger2BuilderConfig {
+    responseTypeResolver?: (apiOperation: Swagger3ApiOperation) => string;
+    swagger: {
+        /**
+         * swagger域名
+         */
+        domain: string;
+        /**
+         * resourcePath请求路径，默认swagger2的路径
+         */
+        resourcePath?: string;
+        /**
+         * documentPath请求路径，默认swagger2的路径
+         */
+        documentPath?: string;
+        /**
+         * 过滤SwaggerResource，可选择只输出部分SwaggerResource的接口
+         */
+        resourceFilter?: (resource: Swagger3Resource) => boolean;
+        /**
+         * SwaggerResource中过滤paths，更细粒度的根据path过滤
+         */
+        pathFilter?: (resource: Swagger3Resource, url: string, method: string, apiOperation: Swagger3ApiOperation) => boolean;
+        /**
+         * 枚举处理
+         */
+        resolveEnumItem?: (item: string) => NjkEnumItem;
+    };
+}
+
+declare interface Parameter {
+    description: string;
+    in: string;
+    name: string;
+    required: boolean;
+    items?: TypeArray<SampleType>;
+}
+
+declare interface ParameterWrapper {
+    parameters: Parameter[];
+    package: string;
+    name: string;
+    modelPoolMap: Map<string, TsModel>;
+    enumPackageName?: string;
+    paramPackageName?: string;
+}
+
+declare interface Response_2 {
+    description: string;
+}
+
+declare interface ResponseWrapper {
+    response: Response_2;
+    modelPoolMap: Map<string, TsModel>;
+}
+
+declare interface SampleModelProperty extends ModelProperty, SampleType {
+    format?: string;
+}
+
+declare interface SampleType {
+    type: string;
+}
+
+declare class Swagger2ApiOperationTranslator implements Translator<ApiOperationWrapper, TsApi> {
+    protected parameterTranslator: Swagger2ParameterTranslator;
+    protected responseTranslator: Swagger2ResponseTranslator;
+    protected genericityDependenciesTranslator: TsGenericityDependenciesTranslator;
+    translate(data: ApiOperationWrapper): TsApi;
+    resolveServiceName(name: string): string;
+    resolveApiName(name: string, options?: ApiOperationResolveApiName): string;
+    resolveApiParameterName(name: string, options?: ApiOperationResolveApiName): string;
+    /**
+     * responseType解析
+     * @param apiOperation
+     */
+    responseTypeResolver(apiOperation: ApiOperation): string;
+}
+
+declare class Swagger2EnumModelTranslator implements Translator<EnumModelPropertyWrapper, TsEnumModel> {
+    translate(data: EnumModelPropertyWrapper): TsEnumModel;
+}
+
+declare class Swagger2ModelPropertyTranslator implements Translator<ModelPropertyWrapper, TsModelProperty> {
+    translate(data: ModelPropertyWrapper): TsModelProperty;
+}
+
+declare class Swagger2ModelTranslator implements Translator<ModelWrapper, TsModel | null> {
+    protected modelPropertyTranslator: Swagger2ModelPropertyTranslator;
+    protected enumModelPropertyTranslator: Swagger2EnumModelTranslator;
+    translate(data: ModelWrapper): TsModel | null;
+}
+
+declare class Swagger2ParameterTranslator implements Translator<ParameterWrapper, TsApiParameter> {
+    protected enumModelPropertyTranslator: Swagger2EnumModelTranslator;
+    translate(data: ParameterWrapper): TsApiParameter;
+}
+
+declare class Swagger2ResponseTranslator implements Translator<ResponseWrapper, TsApiResponse | null> {
+    translate(data: ResponseWrapper): TsApiResponse | null;
+}
+
+declare interface Swagger3ApiComponent {
+    schemas: Data<Swagger3Model>;
+}
+
+declare interface Swagger3ApiDoc {
+    components: Swagger3ApiComponent;
+    info: Swagger3ApiInfo;
+    openapi: string;
+    paths: Swagger3ApiPath;
+    servers: Swagger3ApiServer[];
+    tags: Swagger3ApiTag[];
+}
+
+declare interface Swagger3ApiInfo {
+    contact: SwaggerApiInfoContact;
+    description: string;
+    title: string;
+    version: string;
+}
+
+declare interface Swagger3ApiOperation {
+    operationId: string;
+    responses: Swagger3HttpResponses;
+    summary: string;
+    tags?: string[];
+    produces?: string[];
+}
+
+declare interface Swagger3ApiOperationResolveApiName {
+    map?: CountMap;
+    countName?: (name: string) => string;
+}
+
+declare class Swagger3ApiOperationTranslator implements Translator<Swagger3ApiOperationWrapper, TsApi> {
+    protected parameterTranslator: Swagger3ParameterTranslator;
+    protected requestBodyTranslator: Swagger3RequestBodyTranslator;
+    protected responseTranslator: Swagger3ResponseTranslator;
+    protected genericityDependenciesTranslator: Swagger3TsGenericityDependenciesTranslator;
+    translate(data: Swagger3ApiOperationWrapper): TsApi;
+    resolveServiceName(name: string): string;
+    resolveApiName(name: string, options?: Swagger3ApiOperationResolveApiName): string;
+    resolveApiParameterName(name: string, options?: Swagger3ApiOperationResolveApiName): string;
+    /**
+     * responseType解析
+     *
+     * @param {Swagger3ApiOperation} apiOperation
+     * @returns {string}
+     *
+     * @memberOf Swagger3ApiOperationTranslator
+     */
+    responseTypeResolver(apiOperation: Swagger3ApiOperation): string;
+}
+
+declare interface Swagger3ApiOperationWrapper {
+    serviceName: string;
+    operationName: string;
+    package: string;
+    url: string;
+    method: string;
+    apiOperation: Swagger3ApiOperation;
+    responseTypeResolver?: (apiOperation: Swagger3ApiOperation) => string;
+    modelPoolMap: Map<string, TsModel>;
+}
+
+declare interface Swagger3ApiPath {
+    [prop: string]: Data<Swagger3ApiOperation>;
+}
+
+declare interface Swagger3ApiServer {
+    description: string;
+    url: string;
+}
+
+declare interface Swagger3ApiTag {
+    name: string;
+    description: string;
+}
+
+declare interface Swagger3ArrayType<T> {
+    type: 'array';
+    items: T;
+}
+
+declare type Swagger3ComplexType = Swagger3Ref | Swagger3SampleType | Swagger3ArrayType<Swagger3Ref> | Swagger3ArrayType<Swagger3SampleType>;
+
+declare interface Swagger3EnumModelProperty extends Swagger3ModelProperty {
+    type: 'string' | 'array';
+    enum: string[];
+    items?: Swagger3EnumModelProperty;
+}
+
+declare interface Swagger3EnumModelPropertyWrapper {
+    package: string;
+    modelProperty: Swagger3EnumModelProperty;
+    modelPropertyName: string;
+    modelName: string;
+    resolveEnumItem?: (item: string) => NjkEnumItem;
+}
+
+declare class Swagger3EnumModelTranslator implements Translator<Swagger3EnumModelPropertyWrapper, TsEnumModel> {
+    translate(data: Swagger3EnumModelPropertyWrapper): TsEnumModel;
+}
+
+declare interface Swagger3HttpResponse {
+    description: string;
+    content?: Data<Swagger3Response>;
+}
+
+declare interface Swagger3HttpResponses {
+    [prop: number]: Swagger3HttpResponse;
+}
+
+declare interface Swagger3Model {
+    type: string;
+    title?: string;
+    required?: string;
+}
+
+declare interface Swagger3ModelProperty {
+    description?: string;
+    format?: string;
+    allOf?: Swagger3Ref[];
+    oneOf?: Swagger3Ref[];
+}
+
+declare class Swagger3ModelPropertyTranslator implements Translator<Swagger3ModelPropertyWrapper, TsModelProperty> {
+    translate(data: Swagger3ModelPropertyWrapper): TsModelProperty;
+}
+
+declare interface Swagger3ModelPropertyWrapper {
+    modelProperty: Swagger3ModelProperty;
+    modelPropertyName: string;
+    model: Swagger3Model;
+    modelName: string;
+}
+
+declare class Swagger3ModelTranslator implements Translator<Swagger3ModelWrapper, TsModel | null> {
+    protected modelPropertyTranslator: Swagger3ModelPropertyTranslator;
+    protected enumModelPropertyTranslator: Swagger3EnumModelTranslator;
+    translate(data: Swagger3ModelWrapper): TsModel;
+}
+
+declare interface Swagger3ModelWrapper {
+    package: string;
+    modelName: string;
+    model: Swagger3Model;
+    resolveEnumItem?: (item: string) => NjkEnumItem;
+}
+
+declare interface Swagger3Parameter {
+    in: Swagger3ParameterIn | string;
+    name: string;
+    required: boolean;
+    style: string;
+    schema: Swagger3Model;
+    description?: string;
+    format?: string;
+}
+
+declare enum Swagger3ParameterIn {
+    header = "header",
+    query = "query",
+    path = "path",
+    body = "body",
+    formData = "formData"
+}
+
+declare class Swagger3ParameterTranslator implements Translator<Swagger3ParameterWrapper, TsApiParameter> {
+    protected enumModelPropertyTranslator: Swagger3EnumModelTranslator;
+    translate(data: Swagger3ParameterWrapper): TsApiParameter;
+}
+
+declare interface Swagger3ParameterWrapper {
+    parameters: Swagger3Parameter[];
+    package: string;
+    name: string;
+    modelPoolMap: Map<string, TsModel>;
+    resolveEnumItem?: (item: string) => NjkEnumItem;
+}
+
+declare interface Swagger3Ref {
+    $ref: string;
+}
+
+declare interface Swagger3RequestBody {
+    contentType?: string;
+    schema: Swagger3ComplexType;
+}
+
+declare class Swagger3RequestBodyTranslator implements Translator<Swagger3RequestBodyWrapper, TsApiParameter> {
+    translate(data: Swagger3RequestBodyWrapper): TsApiParameter;
+}
+
+declare interface Swagger3RequestBodyWrapper {
+    requestBody: Swagger3RequestBody;
+    package: string;
+    name: string;
+    modelPoolMap: Map<string, TsModel>;
+}
+
+declare interface Swagger3Resource {
+    location: string;
+    name: string;
+    swaggerVersion: string;
+    url: string;
+}
+
+declare interface Swagger3Response {
+    responseType: string;
+}
+
+declare class Swagger3ResponseTranslator implements Translator<Swagger3ResponseWrapper, TsApiResponse | null> {
+    translate(data: Swagger3ResponseWrapper): TsApiResponse | null;
+}
+
+declare interface Swagger3ResponseWrapper {
+    responses: Swagger3HttpResponses;
+    modelPoolMap: Map<string, TsModel>;
+}
+
+declare interface Swagger3SampleType {
+    type: string;
+}
+
+declare class Swagger3Service {
+    protected domain: string;
+    protected resourcePath: string;
+    protected documentPath: string;
+    constructor(domain: string, resourcePath?: string, documentPath?: string);
+    /**
+     * 获取 Swagger3Resource[]
+     */
+    listSwaggerResources(): Promise<Swagger3Resource[]>;
+    /**
+     * 获取 Swagger3ApiDoc
+     * @param group
+     */
+    getApiDoc(group: string): Promise<Swagger3ApiDoc>;
+}
+
+declare class Swagger3TsGenericityDependenciesTranslator extends TsGenericityDependenciesTranslator {
+}
+
+declare interface SwaggerApiInfoContact {
+    email: string;
+    name: string;
+    url: string;
+}
+
+declare interface SwaggerResource {
+    location: string;
+    name: string;
+    swaggerVersion: string;
+    url: string;
+}
+
+declare interface SwaggerResource {
+    location: string;
+    name: string;
+    swaggerVersion: string;
+    url: string;
+}
+
+declare class SwaggerService {
+    protected domain: string;
+    protected resourcePath: string;
+    protected documentPath: string;
+    constructor(domain: string, resourcePath?: string, documentPath?: string);
+    /**
+     * 获取 SwaggerResource[]
+     */
+    listSwaggerResources(): Promise<SwaggerResource[]>;
+    /**
+     * 获取 ApiDoc
+     * @param group
+     */
+    getApiDoc(group: string): Promise<ApiDoc>;
+}
+
+declare interface Translator<T, R> {
+    /**
+     * 转化
+     * @param data
+     */
+    translate(data: T): R;
+}
+
+declare interface TsApi extends NjkApi {
+}
+
+declare interface TsApiParameter extends NjkApiParameter, TsModel {
+    parent?: TsModelType;
+}
+
+declare interface TsApiResponse extends NjkApiResponse {
+    /**
+     * 类型
+     *
+     * @type {TsModelType}
+     * @memberOf TsApiResponse
+     */
+    modelType: TsModelType;
+}
+
+declare interface TsEnumModel extends NjkEnumModel {
+}
+
+/**
+ * 泛型
+ *
+ * @export
+ * @interface TsGenericity
+ */
+declare interface TsGenericity {
+    /**
+     * 类名
+     *
+     * @type {string}
+     * @memberOf TsGenericity
+     */
+    className: string;
+    /**
+     * 包含内部所有的类名
+     *
+     * @type {string[]}
+     * @memberOf TsGenericity
+     */
+    classNames: string[];
+    /**
+     * 占位符
+     *
+     * @type {string}
+     * @memberOf TsGenericity
+     */
+    replaceName: string;
+    /**
+     * 包含内部所有的占位符
+     *
+     * @type {string[]}
+     * @memberOf TsGenericity
+     */
+    replaceNames: string[];
+    /**
+     * 显示名称,
+     * showName直接包含了className => ClassName<...Genericities>
+     *
+     * @type {string}
+     * @memberOf TsGenericity
+     */
+    showName: string;
+    /**
+     * 泛型显示名称
+     *
+     * @type {string}
+     * @memberOf TsGenericity
+     */
+    replaceShowName: string;
+    /**
+     * 内部泛型
+     *
+     * @type {TsGenericity[]}
+     * @memberOf TsGenericity
+     */
+    genericities: TsGenericity[];
+}
+
+/**
+ * 计算出TsGenericity的所有依赖
+ */
+declare class TsGenericityDependenciesTranslator implements Translator<TsGenericityWrapper, NjkDependency[]> {
+    translate(data: TsGenericityWrapper): NjkDependency[];
+    resolveTsModelTypeDependencies(modelType: TsModelType, modelPoolMap: Map<string, TsModel>, dependencies?: NjkDependency[]): NjkDependency[];
+}
+
+declare interface TsGenericityWrapper {
+    package: string;
+    genericity: TsGenericity;
+    modelPoolMap: Map<string, TsModel>;
+}
+
+declare interface TsModel extends NjkModel {
+    /**
+     * 包含的枚举类型
+     *
+     * @type {TsModel[]}
+     * @memberOf TsModel
+     */
+    enumModels?: TsEnumModel[];
+    /**
+     * 泛型
+     *
+     * @type {TsGenericity}
+     * @memberOf TsModelProperty
+     */
+    genericity?: TsGenericity;
+}
+
+declare interface TsModelProperty extends NjkModelProperty {
+    /**
+     * 属性修饰符
+     *
+     * @type {TsModelPropertyModifer}
+     * @memberOf TsModelProperty
+     */
+    modifier: TsModelPropertyModifer;
+}
+
+declare enum TsModelPropertyModifer {
+    package = "",
+    public = "public",
+    protected = "protected",
+    private = "private"
+}
+
+declare interface TsModelType {
+    /**
+     * 名称
+     *
+     * @type {string}
+     * @memberOf TsModelType
+     */
+    name: string;
+    /**
+     * 限定类型
+     *
+     * @type {TsModelTypeRestrict}
+     * @memberOf TsModelType
+     */
+    type: TsModelTypeRestrict;
+    /**
+     * 是否为数组
+     *
+     * @type {boolean}
+     * @memberOf TsModelType
+     */
+    isArray: boolean;
+    /**
+     * 引用类型时为指定的引用对象
+     * 泛型时为泛型定义
+     *
+     * @type {TsModel | TsGenericity}
+     * @memberOf TsModelType
+     */
+    target?: TsModel | TsGenericity;
+}
+
+declare enum TsModelTypeRestrict {
+    /**
+     * 基础类型
+     */
+    sample = 0,
+    /**
+     * 引用类型
+     */
+    ref = 1,
+    /**
+     * 泛型
+     */
+    genericity = 2
+}
+
+declare interface TsService extends NjkService {
+}
+
+declare interface TypeArray<T> {
+    type: 'array';
+    items: T;
+}
+
+export { }