Quick Start

Initialization

Execute the following command in the project root directory:

Global command:

Dart

autoapi init -l dart

TypeScript

autoapi init -l ts

ArkTS

autoapi init -l arkTs

UniApp

autoapi init -l uniapp

Local command:

Dart

npx autoapi init -l dart

TypeScript

npx autoapi init -l ts

ArkTS

npx autoapi init -l arkTs

UniApp

npx autoapi init -l uniapp

This command will generate the ApiSorcery configuration file 【.autoapirc.json】 in the project root directory. Using a Dart project as an example, the content is as follows:

{
  "application": {
    "name": "AutoAPI Test Application",
    "language": "dart",
    "outputDir": "./lib/apis/auto"
  },
  "services": [
    {
      "code": "product",
      "name": "Product Service",
      "token": "682db637-0f31-4847-9cdf-3232432dfsfd",
      "version": 3,
      "enabled": true,
      "source": "http://localhost:9002/swagger-json",
      "returnLevel": "second",
      "returnSecondField": "data",
      "tagNameMap": {
        "User Management": "User",
        "User Authentication": "Auth",
        "Application Management": "Application"
      }
    }
  ]
}

For configuration details, please refer to: Application Configuration | Service Configuration

Device Registration

Before generating APIs, you need to register your current device with a valid token:

Global command:

autoapi register -t <your-token>

Local command:

npx autoapi register -t <your-token>

Replace <your-token> with your actual token. This step is required to authenticate your device and enable API generation.

Generate APIs

autoapi generate

This command will generate the following content:

### % autoapi generate
Starting to parse configuration file
Configuration file location: ./.autoapirc.json
Configuration file parsing completed: 1 service found
----------------------------------------
Starting to process service 1
----------------------------------------

Starting to parse Swagger file
Swagger file parsing completed

Starting to generate Model files
Starting to generate custom classes
Starting to generate request parameter classes
Starting to generate response parameter classes
Starting to generate schema classes
Starting to output model files
Output file location: ./src/api/auto/product/model.ts
Model file generation completed

Starting to generate Base files
Output file location: ./src/api/auto/product/base.ts
Base file generation completed

Starting to generate API files
Output directory: ./src/api/auto/product
Starting to generate API class: ApiUser
Starting to generate API class: ApiAuth
Starting to generate API class: ApiApplication
Starting to generate API class: ApiServer
Starting to generate API class: ApiReport
API file generation completed

----------------------------------------
Service 1 processing completed
----------------------------------------