@apisorcery/autoapi

Installation

Using npm:

npm i @apisorcery/autoapi -g
npm i @apisorcery/autoapi --save-dev

Usage

Initialization

// Initialize in a Dart project
autoapi init -l dart

// Initialize in a TypeScript project
autoapi init -l ts

This command will generate the AutoAPI configuration file [.autoapirc.json] in the project root directory. Taking a Dart project as an example, the content is as follows:

{
  "application": {
    "name": "DemoApplication",
    "language": "ts",
    "outputDir": "./src/apis/auto"
  },
  "servers": [
    {
      "code": "demo",
      "name": "DemoService",
      "token": "72735b33815c4e5c9c2a924a8f4907ef",
      "version": 3,
      "enabled": true,
      "source": "https://apisorcery.com/demo-api/swagger-json",
      "returnLevel": "second",
      "returnSecondField": "data",
    }
  ]
}

Generate API

autoapi generate

This command will generate the following content:

### % autoapi generate
Starting to parse configuration file
Configuration file path: /Users/markhe/Code/hk-business/ruoqing/ruoqing-autoapi-cli-node/.autoapirc.json
Application name: DemoApplication
Application target language: ts
Application API output directory: ./src/apis/auto
Configuration file parsing completed: 1 services found

----------------------------------------
Starting to process service #1
----------------------------------------

Starting service configuration validation
Service code: demo
Service name: DemoService
Service source: https://apisorcery.com/demo-api/swagger-json
Service configuration validation completed

Starting to clean service output files
Original output directory: /Users/markhe/Code/hk-business/ruoqing/ruoqing-autoapi-cli-node/src/apis/auto/demo
Service output files cleanup completed

Starting to fetch Swagger file
Swagger file fetching completed

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 file
Output file path: /Users/markhe/Code/hk-business/ruoqing/ruoqing-autoapi-cli-node/src/apis/auto/demo/model.ts
Model files generation completed

Starting to generate Base files
Output file path: /Users/markhe/Code/hk-business/ruoqing/ruoqing-autoapi-cli-node/src/apis/auto/demo/base.ts
Base files generation completed

Starting to generate API files
Output directory: /Users/markhe/Code/hk-business/ruoqing/ruoqing-autoapi-cli-node/src/apis/auto/demo
Starting to generate API class: ApiUser
Starting to generate API class: ApiFile
API files generation completed

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

All auto-generation tasks completed, thank you for using!