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

@urland/api-generator

v0.0.6

Published

docs Api接口生成脚步

Downloads

50

Readme

根据 docs Api生成接口及TS类型脚本

稳定版0.0.1版本生成的API,暂不支持一个页面取多端接口前缀
内测版0.0.2-alpha.1 新增dynamicApi属性,支持生成api.get(xxx)一接口多端复用模式。

使用指南

 第一步:`npm i @urland/api-generator -D`
 第二步: 在项目根目录中添加`api-generator-config.ts`配置文件
            ```export default {
                    providers: {
                        'common-api': {
                            url: 'https://xxx/docs/common-api',
                        },
                        'admin-api': {
                             url: `https://xxx/docs/admin-api`,
                        },
                        'boss-api': {
                              url: `https://xxx/docs/boss-api`,
                        },
                    },
                };
            ```   
   第三步:在`package.json`文件`scripts中添加命令`           
            ``` 
              "scripts": {
                "sync-api": "sync-api && yarn run lint-fix-api",
                "lint-fix-api": "eslint --fix --ext .ts src/models src/services",
              }
            ```
   第四步:执行 npm run sync-api 即可生成代码  
          
lint-fix-api命令为eslint格式生成后的代码,可参考@urland/eslint-config包进行配置,也可自行安装eslint。

属性指南

providers:配置docsApi地址,如上图common-api作为key。根据key去生成目录及请求api接口类型。如以下:bossApi.get(xxxx)

        export const getUsersCellphoneNumber = async (cellphoneNumber: string, config: AxiosRequestConfig = {}): Promise<UrApiResponse<User>> => {
            const response = await bossApi.get<User>(`/users/cellphone-number/${cellphoneNumber}`, {}, config);
            return response;
        };

dynamicApi: true   //支持生成api.get(xxx)一接口多端复用模式,除commonApi以外,如api.post(xxxx)。   注:默认不填则按照providers的key为类型

        export const getUsersCellphoneNumber = async (cellphoneNumber: string, config: AxiosRequestConfig = {}): Promise<UrApiResponse<User>> => {
            const response = await api.get<User>(`/users/cellphone-number/${cellphoneNumber}`, {}, config);
            return response;
        };