Swaxios: 基于 Axios 和 TypeScript 的 Swagger API 客户端生成器

Swaxios 是一个使用 TypeScript 编写,基于 Axios 的 API 客户端生成器。它可以解析 Swagger (v2.0) 规范文件 (JSON 或 YAML 格式),并生成使用 Axios 与您的 API 通信的 TypeScript 代码。

安装

您可以全局安装 Swaxios:

npm i -g swaxios

或者将其添加到您的项目依赖中:

npm i swaxios

您的项目还需要安装 Axios 和 TypeScript:

npm i axios
npm i -D typescript

使用

# 查看所有 CLI 选项
swaxios --help

# 提供 Swagger 输入文件 (JSON 或 YAML)
swaxios -i ./path/to/swagger.json -o ./path/to/output/directory 
swaxios -i ./path/to/swagger.yml -o ./path/to/output/directory 

通过以上命令,Swaxios 将会读取您的 Swagger 文件,并生成使用 Axios 和 TypeScript 编写的 API 客户端代码到指定的输出目录。

zip
swaxios-main.zip 预估大小:64个文件
folder
swaxios-main 文件夹
file
.lintstagedrc.json 143B
file
package.json 3KB
file
tslint.json 214B
file
.yarnrc 54B
folder
.github 文件夹
file
dependabot.yml 145B
folder
workflows 文件夹
file
continuous-integration.yml 670B
file
.prettierignore 131B
file
logo.svg 2KB
folder
src 文件夹
file
Swaxios.ts 5KB
folder
templates 文件夹
file
APIClient.hbs 994B
file
Resource.hbs 2KB
file
index.hbs 182B
file
Interface.hbs 318B
folder
test 文件夹
folder
snapshots 文件夹
file
2-deep-nested-endpoints.ts.fixture 1KB
file
4-delete-by-id-number-with-response.json 701B
file
2-deep-nested-endpoints.json 931B
file
9-special-characters.ts.fixture 962B
file
8-definitions-CreateAccountRequest.ts.fixture 265B
file
9-special-characters.json 968B
file
3-delete-by-id-number.json 631B
file
8-definitions.json 3KB
file
1-query-param-description.json 3KB
file
3-delete-by-id-number.ts.fixture 550B
file
1-query-param-description.ts.fixture 859B
file
6-operationId.json 672B
file
10-openapi-3-header.json 224B
file
5-query-param-required.json 920B
file
7-bearer-auth.json 754B
file
5-query-param-required.ts.fixture 660B
file
6-operationId.ts.fixture 554B
file
4-delete-by-id-number-with-response.ts.fixture 603B
file
8-definitions-CreateAccountResponse.ts.fixture 218B
file
7-bearer-auth.ts.fixture 757B
folder
fixtures 文件夹
file
wire-ets.json 53KB
file
lambot-server.json 1KB
file
wire-sso.json 13KB
file
cli.ts 1004B
folder
generators 文件夹
file
InterfaceGenerator.ts 7KB
file
MethodGenerator.test.ts 4KB
file
ResourceGenerator.ts 2KB
file
APIClientGenerator.ts 3KB
file
APIClientGenerator.test.ts 1KB
file
IndexFileGenerator.ts 1015B
file
ResourceGenerator.test.ts 631B
file
MethodGenerator.ts 8KB
file
TemplateGenerator.ts 2KB
file
index.ts 185B
file
Swaxios.test.ts 7KB
folder
util 文件夹
file
StringUtil.test.ts 1KB
file
FileUtil.test.ts 305B
file
FileUtil.ts 2KB
file
StringUtil.ts 1KB
folder
validator 文件夹
file
SwaggerValidator.ts 637B
file
index.ts 58B
file
tsconfig.json 526B
file
jasmine.json 116B
file
.gitignore 111B
file
CHANGELOG.md 6KB
file
logo.png 42KB
file
.nycrc.json 236B
file
README.md 3KB
file
yarn.lock 120KB
file
.huskyrc.json 53B
file
.editorconfig 147B
...
zip 文件大小:125.94KB