# @geosanja/geosanja-frontend-api 中文文档

规范地址：https://npmcn.com/package/%40geosanja/geosanja-frontend-api/

版本：4\.16\.0-build-1
npm 元数据更新时间：2026-11-13T20:50:43.502Z
中文译文更新时间：2026-11-16T05:01:14.072Z
软件包许可：Unlicense

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40geosanja/geosanja-frontend-api
原文对照：https://npmcn.com/package/%40geosanja/geosanja-frontend-api/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.3 MB，183 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-04-01T19:19:10.421Z
- 最新版本发布：2026-11-13T20:50:43.289Z
- 近 30 天下载量：2400（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：184（近 12 个月 99 个）

## 中文简介

@ geosanja/ geosanja- frontend- api 的 swagger 客户端

## 安装

```sh
npm install @geosanja/geosanja-frontend-api
```

也可以使用：`pnpm add @geosanja/geosanja-frontend-api`、`yarn add @geosanja/geosanja-frontend-api`、`bun add @geosanja/geosanja-frontend-api`

## README

## @geosanja/geosanja-frontend-api@1.0

### 大楼

要安装所需的依赖性并构建运行的打字源:

```
npm install
npm run build
```

### 出版

首先构建软件包而不是运行 `npm publish dist` (别忘了说明) `dist` 文件夹

### 消费

导航到您耗用工程的文件夹并运行下一个命令 .

_已出版:_

```
npm install @geosanja/geosanja-frontend-api@1.0.0 --save
```

_(不建议):_

```
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```

带取tgz文件很重要,否则会给窗口的链接带来麻烦.

_使用 `npm link`数字 :_

在 PATH TO GENERTED PACKAGE/dist中:

```
npm link
```

在你的项目中:

```
npm link @geosanja/geosanja-frontend-api
```

**用于 Windows 用户的说明 :** 角 CLI 有使用链接npm包的麻烦. 请参考这个问题 [https://github.com/angular/angular-cli/issues/8284 (中文(简体) )](https://github.com/angular/angular-cli/issues/8284) 解决/解决. 出版的套件不是由本期实施的.

#### 一般用途

在您的角工程中 :

```
// without configuring providers
import { ApiModule } from '@geosanja/geosanja-frontend-api';
import { HttpClientModule } from '@angular/common/http';


@NgModule({
    imports: [
        ApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule
    ],
    declarations: [ AppComponent ],
    providers: [],
    bootstrap: [ AppComponent ]
})
export class AppModule {}
```

```
// configuring providers
import { ApiModule, Configuration, ConfigurationParameters } from '@geosanja/geosanja-frontend-api';

export function apiConfigFactory (): Configuration => {
  const params: ConfigurationParameters = {
    // set configuration parameters here.
  }
  return new Configuration(params);
}

@NgModule({
    imports: [ ApiModule.forRoot(apiConfigFactory) ],
    declarations: [ AppComponent ],
    providers: [],
    bootstrap: [ AppComponent ]
})
export class AppModule {}
```

```
import { DefaultApi } from '@geosanja/geosanja-frontend-api';

export class AppComponent {
     constructor(private apiGateway: DefaultApi) { }
}
```

注意: ApiModule 被限制为一旦应用宽被即时化. 这样做是为了确保所有服务都被视为单吨.

#### 使用多个 swagger 文件 / APIs / ApiModules

为了使用多个 `ApiModules` 从不同的 swagger 文件生成, 您可以在导入模块时创建别名 为了避免命名冲突:

```
import { ApiModule } from 'my-api-path';
import { ApiModule as OtherApiModule } from 'my-other-api-path';
import { HttpClientModule } from '@angular/common/http';


@NgModule({
  imports: [
    ApiModule,
    OtherApiModule,
    // make sure to import the HttpClientModule in the AppModule only,
    // see https://github.com/angular/angular/issues/20575
    HttpClientModule
  ]
})
export class AppModule {

}
```

### 设置服务基础路径

如果与生成的基础路径不同,在应用靴子时,您可以提供服务的基础路径.

```
import { BASE_PATH } from '@geosanja/geosanja-frontend-api';

bootstrap(AppComponent, [
    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);
```

或者说

```
import { BASE_PATH } from '@geosanja/geosanja-frontend-api';

@NgModule({
    imports: [],
    declarations: [ AppComponent ],
    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
    bootstrap: [ AppComponent ]
})
export class AppModule {}
```

#### 使用@ angular/ cli

第一次扩展你的 `src/environments/*.ts` 通过添加相应的基础路径来创建文件 :

```
export const environment = {
  production: false,
  API_BASE_PATH: 'http://127.0.0.1:8080'
};
```

在src/app/app.module.ts中:

```
import { BASE_PATH } from '@geosanja/geosanja-frontend-api';
import { environment } from '../environments/environment';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [ ],
  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
  bootstrap: [ AppComponent ]
})
export class AppModule { }
```

## 常见问题

### @geosanja/geosanja-frontend-api 是什么？

@ geosanja/ geosanja- frontend- api 的 swagger 客户端

### 如何安装 @geosanja/geosanja-frontend-api？

在项目目录运行 npm install @geosanja/geosanja-frontend-api，或使用 pnpm add / yarn add / bun add。

### @geosanja/geosanja-frontend-api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @geosanja/geosanja-frontend-api 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @geosanja/geosanja-frontend-api 可以商用吗？

@geosanja/geosanja-frontend-api 使用 Unlicense 许可。作者将代码贡献到公共领域，可不受限制地使用。以上为概括，不构成法律意见，请以许可原文为准。

### @geosanja/geosanja-frontend-api 的下载量有多少？

根据 npm 官方下载统计，@geosanja/geosanja-frontend-api 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,400 次，日均约 80 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @geosanja/geosanja-frontend-api 还在维护吗？

最新版本 4\.16\.0-build-1 发布于 2026/11/14（2 天前）；至今共发布 184 个版本，其中过去 12 个月发布了 99 个；首次发布于 2025/04/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

