npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

auto-create-api

v1.0.0

Published

根据配置文件及模板自动生成api

Downloads

11

Readme

根据给定模版自动生成api文件

Install

npm install auto-create-api -D

Example

path config file(paths.config)

// 'method|url': requestType|responseType|isAuth:[0|1]
// 如:"get|/profile/password/reset/confirm/edit": "String|JSON|0"

// 如果路径中存在变量,则需要在入参中添加变量名,
// 如:`/user/subuser/list/{id}`,同时在调用请求接口时,需要将变量名添加到请求参数中
// 如:`requestName({id: 1,other: 'xxx'})`

paths.json

{
  "get|/profile/password/reset/confirm/edit": "String|JSON|0",
  "get|/profile/detail/{id}/edit": "FormData|String|1",
  "get|/user/detail/{name}/edit": "FormData|FormData|1",
  "get|/user/subuser/list": "String|Blob|1",
  "get|/user/subuser/list/{id}": "String|ArrayBuffer|1",
  "post|/user/subuser/list/{id}/{name}": "String|JSON|1",
  "post|/service-user/user/getUserInfo": "String|JSON|1",
  "post|/service-sso/sso/login": "String|JSON|1",
  "post|/service-sso": "String|JSON|1",
  "get|/service-sso": "String|JSON|1",
  "post|/service-sso/sso": "String|JSON|1",
  "post|/service-list/sso/login": "String|JSON|1"
}

Vite

// vite.config.js
import autoCreateApi from 'auto-create-api/rollup'

export default defineConfig({
  plugins: [
    // ...
    autoCreateApi({/* options */}), 
    // ...
  ],
})

Rollup

// rollup.config.js
import autoCreateApi from 'auto-create-api/rollup'

export default defineConfig({
  plugins: [
    // ...
    autoCreateApi({/* options */}), 
    // ...
  ],
})

Configuration

plugin

autoCreateApi({
  // 生成的文件父级目录 
  folderPath: 'apis',
  // 接口路径配置文件名称,在folderPath下
  pathsFileName: 'paths.json',
  // 是否生成ts文件
  ts: false,
  // 是否输出日志
  log:false 
})

Result

before create

src
├── apis // 存放接口文件
│   ├── paths.json // 接口路径配置文件
│   ├── request.js // 封装的接口请求方法 默认与paths.json同级目录,文件名为request,暂不支持修改
...

after create

src
├── apis // 存放接口文件
│   ├── user // 根据url第一段路径生成
│       └── subuser.api.js // 根据url第二段路径命名
│   ├── profile 
│       └── detail.api.js
│   ├── paths.json // 接口路径配置文件
│   ├── request.js // 封装的接口请求方法 默认与paths.json同级目录,文件名为request,暂不支持修改
...