# generator-swagger-ts

**Repository Path**: mmyhs/generator-swagger-ts

## Basic Information

- **Project Name**: generator-swagger-ts
- **Description**: 自主开发的一个将swagger文档转换成ts解释文本的一个yeoman工具
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-15
- **Last Updated**: 2023-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### generator-swagger-ts
自主开发的一个将swagger文档转换成ts解释文本的一个yeoman工具


## Installation

First, install [Yeoman](http://yeoman.io) and generator-swagger-ts using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-swagger-ts
```

Then generate your new project:

```bash
yo swagger-ts
```
#### 0.0.3
> 完成第一阶段的开发任务
> 1. 支持根据swagger文档生成对应的ts和js的相关api代码，增强代码的编写速度，提供代码感应的支持
> 2. 对每个api方法注释，对整个API类进行简单说明
> 3. 支持主动注入axios，亦可以只传入 `baseUrl`
> PS: 下一个版本将支持其他的网络请求框架 


#### 0.0.2
> 完成TypeScript的文档转换，目前只支持type文档的生成，下一步将支持同步生成axios的请求api类

## Getting To Know Yeoman

 * Yeoman has a heart of gold.
 * Yeoman is a person with feelings and opinions, but is very easy to work with.
 * Yeoman can be too opinionated at times but is easily convinced not to be.
 * Feel free to [learn more about Yeoman](http://yeoman.io/).


## License

MIT © [mmyhs]()


[npm-image]: https://badge.fury.io/js/generator-swagger-ts.svg
[npm-url]: https://npmjs.org/package/generator-swagger-ts
[travis-image]: https://travis-ci.com//generator-swagger-ts.svg?branch=master
[travis-url]: https://travis-ci.com//generator-swagger-ts
[daviddm-image]: https://david-dm.org//generator-swagger-ts.svg?theme=shields.io
[daviddm-url]: https://david-dm.org//generator-swagger-ts