swagger-autoapi

1.1.8 • Public • Published

swagger-Autoapi

Swagger to JS & Vue & Axios Codegen

Installation

npm install swagger-autoapi --dev --save

Usage

一、在package.json中写入配置信息

{
  "scripts": {
    "autoapi": "autoapi"
  },
  "apihub": {
    "url": "http://xxx.com",
    "projectName": "swagger-project-name",
    "pathPrefix": "/api"
  }
}

二、可以在根目录创建autoapi.config.js文件进行配置

module.exports = {
  url: 'http://xxx.com',
  projectName: 'swagger-project-name',
  pathPrefix: '/api'
}

三、为了解决代码风格问题,读取了当前项目的eslint配置文件,进行代码风格统一

需要生成api时执行npm run autoapi即可。

参数支持说明

  • url swagger地址
  • projectName swagger项目名称
  • pathPrefix 请求路径前缀

Todo List

-[ ] request的封装模板完善 -[X] 允许配置请求path的前缀 -[X] 支持config文件进行配置 -[X] 支持prettier配置进行自定义代码风格 -[ ] 考虑支持ts?自动生成ts类型定义 -[ ] 支持.d.ts文件,便于编辑器提示

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i swagger-autoapi

Weekly Downloads

1

Version

1.1.8

License

MIT

Unpacked Size

20.9 MB

Total Files

4890

Last publish

Collaborators

  • echaoo