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

openapi2type

v1.0.1

Published

Generate the Swagger document of the OpenAPI specification into a frontend interface document

Downloads

7

Readme

使用方法

  1. 安装依赖:npm i openapi2type --save-dev

  2. 创建接口文档文件夹,如:src/api

  3. 创建api.js文件

  4. 引入依赖并使用暴露的函数

    // src/api/api.js
    const transform = require("openapi2ts"); //
    
    transform({
      swaggerPath: "http://swagger-html/doc", // 必填
      namespace: "API", // 生成scchemas的命名空间名称 非必填
      dirname: __dirname, // 获取当前路径,建议填入
      outputPath: "./msw", // 输出路径,非必填,默认为 api文件
      importStatement: "import { requester, AxiosRequestConfig } from './http'", // 引入请求方法和配置类型 必填
      generateRequestFunction: false, // 生成请求函数自定义,建议
    });
    // 自定义
    generateRequestFunction(args){
        const { requestName, optionsName, responsesName, path, method, isHasOption } = args
        // 参数
        // requestName // 请求名
        // optionsName // 请求参数名
        // responsesName // 响应参数名
        // path // 请求路径
        // method // 请求方法
        // isHasOption // 是否存在请求参数
        // 返回自定义的请求函数字符串
        // return string
        // 如:
        return `export const ${requestName} = (options: ${optionsName}, config?: AxiosRequestConfig) =>
            requester<${responsesName}> (${path}, { method: ${method}, ...options }, config)`
    }
  5. 可手动 node 执行,也可以在package.json中 配置脚本执行程序,如:

    "scripts": {
        "api": "node /src/api/api.js"
    }
    // npm run api