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

@easyv/swagger-api-types

v0.1.2

Published

根据 `Swagger` 文档生成 `ts` 类型。

Downloads

5

Readme

类型生成工具

根据 Swagger 文档生成 ts 类型。

使用方式

1. 安装依赖

npm install @easyv/swagger-api-types -D -E

或者

pnpm install @easyv/swagger-api-types -D -E

2.添加配置文件

在根目录添加配置文件,配置文件的类型,目前只支持json。 默认配置文件 swagger.config.json

./swagger.config.json

{
  "url": "xxx", // swagger api 接口文档json地址,注意不是文档地址,一般是后缀docs-json
  "rootDir": "./src", // 项目根路径地址,可不填,默认值为 "./src"
  "override": "./swagger-override.ts" // 覆盖swagger类型的文件,可选
}

3.添加命令

package.json 中添加一个脚本

...
scripts: {
  "types": "easyv-types --config swagger.config.json"
}
...

4.执行命令

npm run types

pnpm types

5.最终结果

最后会在项目目录下生成一下文件:

  1. src/types 目录下生成 api.swagger-schema-types.tsapi.swagger-types.ts 文件

  2. src/constants 目录下生成 api.swagger-constants.ts

注意:生成的文件默认不允许改动,因为一旦改动了,下次生成的时候会被覆盖,改动就无效了。