快速上手

初始化

在项目根目录下执行如下命令：

autoapi init

该命令会在项目根目录下生成 AutoAPI 的配置文件【.autoapirc.json】,内容如下：

{
  "application": {
    "name": "AutoAPI测试应用",
    "language": "ts",
    "outputDir": "./api/auto"
  },
  "servers": [
    {
      "name": "product",
      "token": "682db637-0f31-4847-9cdf-3232432dfsfd",
      "version": 3,
      "enabled": true,
      "source": "http://localhost:9002/swagger-json",
      "returnLevel": "second",
      "returnSecondField": "data",
      "tagNameMap": {
        "用户管理": "User",
        "用户认证": "Auth",
        "应用管理": "Application"
      }
    }
  ]
}

配置详情请参考：应用配置｜服务配置

生成 API

autoapi generate

该命令会生成如下内容：

### % autoapi generate
开始解析配置文件
配置文件地址: ./.autoapirc.json
配置文件解析完成: 共有 1 个服务
----------------------------------------
开始处理第1个服务
----------------------------------------

开始解析Swagger文件
Swagger文件解析完成

开始生成Model文件
开始生成自定义类
开始生成请求参数类
开始生成响应参数类
开始生成schema类
开始输出model文件
输出文件地址: ./src/api/auto/product/model.ts
Model文件生成完成

开始生成Base文件
输出文件地址: ./src/api/auto/product/base.ts
Base文件生成完成

开始生成API文件
输出文件目录：./src/api/auto/product
开始生成API类: ApiUser
开始生成API类: ApiAuth
开始生成API类: ApiApplication
开始生成API类: ApiServer
开始生成API类: ApiReport
API文件生成完成

----------------------------------------
第1个服务处理完成
----------------------------------------