api-init

    1.1.8 • Public • Published

    使用

    使用 npx 执行

    1. 安装 api-init
    npm install api-init --save-dev
    1. 项目接口 API 初始化命令
    • 初始化,默认路径(default: src/api)
    npx api-init install
    
    • 自定义路径,嵌套路径用/连接(如:src/api)
    npx api-init install api
    
    1. 生成接口文档(注:文档路径需要和接口 api 初始化路径相同)
    • api 初始化使用默认路径,则文档命令:
    npx api-init docs
    • api 初始化使用自动义(如:api),则文档命令:
    npx api-init docs api

    使用 npm 执行

    1. 安装 api-init
    npm install api-init --save-dev
    1. package.json 添加 npm scripts 命令
    // package.json
    {
      "scripts": {
        "api-init": "api-init",
      }
    }
    1. 项目接口 API 初始化命令
    • 初始化,默认路径(default: src/api)
    npm run api-init install
    • 自定义路径,嵌套路径用/连接(如:src/api)
    npm run api-init install api
    

    4.生成接口文档(注:文档路径需要和接口 api 初始化路径相同)

    • api 初始化使用默认路径,则文档命令:
    npm run api-init docs
    • api 初始化使用自动义(如:api),则文档命令:
    npm run api-init docs api

    接口 API 默认结构

    ├── src
        ├── api
            ├── docs
                └── index.js        #生成接口文档明显
            ├── modules
                ├── example.js      #接口模块配置
                └── ...
            ├── request
                ├── config.js       #公共请求方法配置
                └── index.js        #封装公共请求方法
            ├── docs.json           #接口方法明显
            └── index.js            #自动生成接口方法
        ├── ...

    添加接口配置

    在 api/modules 目录下添加对应的模块,按照规定添加对应配置项目,就可以生成对应的接口方法,如:

    // 1、modules添加example.js模块
    // 2、添加接口对应配置项
    export default [
      {
        name: "query", // 接口方法名取接口url最后一个单词
        method: "get", // 接口请求方法
        url: "example/query", // 接口url
        params: {}, // 接口默认传参
        docs: "接口说明", // 接口说明注释
      },
    ];

    使用

    // api文件夹配置别名api
    import api from 'api' // 或 import api from '@/api'
    
    // 使用
    api.example.query({ // 参数 })

    相关地址

    api-init 文档地址: https://hugolgw.github.io/api-main

    api-init npm 地址: https://www.npmjs.com/package/api-init

    api-init 源码地址: https://github.com/hugolgw/api-main

    原创不易,欢迎 star

    License

    MIT

    Keywords

    Install

    npm i api-init

    DownloadsWeekly Downloads

    22

    Version

    1.1.8

    License

    MIT

    Unpacked Size

    10.2 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar