swagger-api-function

1.3.3 • Public • Published

swagger-api-function npm package

本项目在基于 vswagger-cli https://www.npmjs.com/package/vswagger-cli 调整,对生成模板进行了简化

  • Installation

Prerequisites: Node.js (>=6.x, 8.x preferred), npm version 3+ and Git.

$ npm install -g swagger-api-function
  • Usage

$ swaggerapi init

Example:

$ swaggerapi init
  • 使用方法(步骤):

  1. 全局安装vswagger
npm install -g swagger-api-function
  1. 添加根目录配置文件 .vswagger.js
/**
 * .vswagger 配置文件
 */

module.exports = {
    safe: true, // 是否生成保护数据
    output: "src/api", // 输出到api目录
    projectDir: "src", // 代码存放目录(可不配置默认为src路径)
    suffix: [".js",".vue"], // 指定查询的文件(可不配置,默认.js,.vue文件)
    projects: [{
       version: '2.0', 
       token: '', // swagger令牌
       modelName: "index", // 模块化名称
       docName:'demo1',
       projectName:'demo1',
       docUrl: ['http://192.168.0.128:7017/v2/api-docs']  // swagger base-url
    }] // 项目配置
};
  1. 生成接口
swaggerapi init
  1. 生成VUE模板(需要规范的crud接口规范)
swaggerapi vue
``

Dependencies (13)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i swagger-api-function

    Weekly Downloads

    6

    Version

    1.3.3

    License

    ISC

    Unpacked Size

    108 kB

    Total Files

    26

    Last publish

    Collaborators

    • ovstar