@tcatche/swagger-api

1.1.0 • Public • Published

swagger-api

根据 Swagger 定义生成 axios api 的请求

Installation

npm install @tcatche/swagger-api --dev

生成代码

const path = require('path')
const swaggerGen = require('@tcatche/swagger-api')
const testJson = require('./test.json')
// 循环初始化API
const opt = {
  swaggers: [
    {
      swagger: swaggerUrl, // swagger 可以为swagger的地址
      ignore: false, // 使用 ignore: true 则不执行此配置,false或不填则会重新生成
      fileName: 'api1', // 指定保存的文件名为api1.js
    },
    {
      swagger: swaggerJSONObj, // swagger 也可以为json 对象
      ignore: false, // 使用 ignore: true 则不执行此配置,false或不填则会重新生成
      fileName: 'api2', // 指定保存的文件名为api2.js
    }
  ],
  swaggersDir: path.join(__dirname, './api/') // 指定生成的文件的目录
}
try {
  swaggerGen.generateApis(opt) // generate 代码
} catch (err) {
  console.log(err)
}

使用生成的代码

使用前必须初始化

import { requester } from './apis/api.js'
requester.setDomain('http://localhost:3000/api')

使用代码

import { userLogin } from '../apis/api.js'

userLogin({
  userInfo: {
    username: 'admin',
    password: 'admin'
  }
}).then(function (resp) {
  console.log(resp.data)
})

All requests use axios module with promise, for more information about that follow axios documentation

Links

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i @tcatche/swagger-api

Weekly Downloads

1

Version

1.1.0

License

MIT

Unpacked Size

2.17 MB

Total Files

32

Last publish

Collaborators

  • tcatche