@zdmin/ara

English | 简体中文

Generate Request Code from OpenAPI specs in seconds

• ​​TypeScript / JavaScript Code Supported
• Type Safety​​ for Both TypeScript / JavaScript (by JSDoc)
• Swagger 2.0 / OpenAPI 3.0 specs Supported
• Chrome Extension for UI & Preview
• ​​Vite / Webpack Supported (Compat with Vite 2.x / Webpack 3.x)
• Node 14+ Supported

usage

1. Setup Project

install: pnpm install -D @zdmin/ara-unplugin

Vite

import { defineConfig } from 'vite'
import Ara from '@zdmin/ara-unplugin/vite'

// https://vite.dev/config/
export default defineConfig({
  plugins: [
    Ara({
      doc: 'https://petstore.swagger.io/'
    }),
    // ...
  ],
  // ...
})

Webpack

import Ara from '@zdmin/ara-unplugin/webpack'
// const Ara = require('@zdmin/ara-unplugin/webpack')

export default {
  plugins: [
    Ara({
      doc: 'https://petstore.swagger.io/'
    }),
    // ...
  ],
  // ...
};

• More Options: @zdmin/ara-unplugin

• Examples:

  • vite example
  • webpack example

for other client project: build your own server like local-server

2. Download & Install Chrome Extension

Why use Chrome Extension?

Since openapi docs behind some auth in common, we use Chrome Extension for getting openapi docs data seamlessly.

• 🚀 Chrome Web Store

• OR if Chrome Web Store not latest, you can:

  1. download manually and unzip it.
  2. load-unpacked chrome extension.

3. Preview & Generate

• Open Chrome DevTools
• Visit OpenAPI doc page
• Preview & Generate Code