将 swagger typescript-fetch api 集成到 aurelia-cli tyepscript 项目中

Question

对于一个 web 项目，我想创建一个 swagger (open api) api 用于后端服务器 (go) 和前端 (aurela-cli + typescript)。

swagger-codegen 工具支持以下客户端生成器
- 打字稿角
- typescript-angular2
- 打字稿节点
- 打字稿提取

现在，前三个显然不适用于这个问题，所以我只剩下typescript-fetch。要从 swagger.yml 生成客户端，我使用以下命令：
swagger-codegen generate -i swagger.yml -l typescript-fetch -o api

这会生成一个项目文件夹，如 swagger repository 所示。

问题是如何将其包含在 aurelia 项目中。

我已经运行了npm install，这导致了一个转译的 api.js（和相应的 api.d.ts）。但是，我不确定下一步如何进行。

1) 我应该把这个文件夹放在哪里？
- src/api
- node-modules/<fake-module-name>
- 别的地方

2) 我如何告知 aurelia aurelia.json 文件中的“模块”？
- "<fake-module-name>"
- "{ "name": "<fake-module-name>", "path": "../node_modules/<fake-module-name>dist", "main": "api" }
- 别的东西

我遇到的主要问题是，即使 aurelia.json 知道模块中的 api，此模块中的依赖项也会导致构建过程（au run --watch) 停止，因为它们以某种方式在前端的src 目录。

任何有关如何解决此问题的帮助将不胜感激。

附：我有一种轻微的感觉，我必须“简单地”将 api 模块的依赖项及其依赖项等导入 aurelia.json ...

Answer 1

我修改了其他一个 TypeScript 生成器来为 Aurelia Fetch Client 生成一个 TypeScript 客户端：

https://github.com/jeremeevans/typescript-aurelia-fetch-client-generator

我的文档现在非常糟糕，但基本步骤是：

1. 克隆 Swagger 代码生成器：git clone https://github.com/swagger-api/swagger-codegen.git
2. 导航到 swagger-codegen 目录并构建/安装它：
   • mvn 清洁包
   • mvn 安装
3. 回到你的 git 目录并克隆 typescript-aurelia-fetch-client-generator：Git clone https://github.com/jeremeevans/typescript-aurelia-fetch-client-generator.git
4. 导航到 typescript-aurelia-fetch-client-generator 目录并构建它：
   • mvn 包

然后为你的库创建一个配置文件：

{
  "packageName": "MyLibraryName",
  "modelPropertyNaming": "original" // if you want to keep your casing on the models.
}

然后构建您的 TypeScript 客户端，导航到 Swagger Codegen 目录并运行：

java -cp '../typescript-aurelia-fetch-client-generator/target/typescript-aurelia-fetch-client-swagger-codegen-1.0.0.jar;./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar' io.swagger.codegen.Codegen -i http://localhost:8080/swagger/docs/v4 -l typescript-aurelia-fetch-client -o c:\temp\OutputFolder -c C:\temp\yourconfig.json

显然，将 http://localhost:8080/swagger/docs/v4 替换为 Swagger 定义的路径。

如果这对您有帮助，请为存储库加注星标。另外，欢迎投稿。