Skip to content

使用 yeoman 工具 自动化编译 swagger.json 文件为前端可使用的接口方法集合。

Notifications You must be signed in to change notification settings

Wuguanghua/generator-swagger-api

Repository files navigation

generator-swagger-api-tool NPM version Build Status Dependency Status Coverage percentage

安装依赖

First, install Yeoman and generator-swagger-api using npm

npm install -g yo
npm install -g generator-swagger-api

Then generate your new project:

yo swagger-api

介绍

  • 支持 js.ejsts.ejs 两种模板文件,(推荐使用 ts.ejs);
  • 可以自定义 classNameOutPutFile;

如何使用

  1. 从服务端人员获得xxx.yaml 文件,导入editor.swagger.io 生成 swagger.json 文件;
  2. 命令行输入yo swagger-api,按照提示操作;
 yo swagger-api

     _-----_     ╭──────────────────────────╮
    |       |    │ Welcome to the beautiful │
    |--(o)--|    │   generator-swagger-api  │
   `---------´   │        generator!
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |     
   __'.___.'__   
 ´   `  |° ´ Y ` 

? 请输入生成器 className Api
? 请选择模板文件 ts.ejs
? 请输入输出文件名(没有文件后缀) api
? 请把 swagger.json 文件拖拽到这里 /Users/***/generators/swagger.json
   create api.ts

引用

了解 Yeoman

Feel free to learn more about Yeoman.

License

ISC © guanghua

About

使用 yeoman 工具 自动化编译 swagger.json 文件为前端可使用的接口方法集合。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published