jadepeng / generator-swagger-2-ts

A Swagger Codegen for typescript and javascript

generator-swagger-2-ts

A Swagger Codegen for typescript and javascript, A Yeoman generator

This package generates a js/typescript class from a swagger url. The code is generated using Yeoman and you can modify template to diy the generated code

中文文档

Installation

First, install Yeoman and generator-swagger-2-ts using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-swagger-2-ts

Then generate your new project:

yo swagger-2-ts

According to the prompt:

• input swagger - UI address, for example: http://192.168.86.8:8051/swagger-ui.html, the package will automatically replace the url address 'swagger-ui.html' to 'v2/api-docs' to get really swagger API docs url, then download and parse it to generate the API class
• choose generate js or typescript
• you can customize the generated API class name, API file name

or you can pass arguments by command:

 yo swagger-2-ts --swaggerUrl=http://localhost:8080/swagger-ui.html --className=API --type=typescript --outputFile=api.ts

• swaggerUrl: swagger ui url
• className： API class name
• type： typescript or javascipt
• outputFile: api file save to

generated CODE：

export type AccountUserInfo = {
  disableTime?: string
  isDisable?: number
  lastLoginIp?: string
  lastLoginPlace?: string
  lastLoginTime?: string
  openId?: string
}


export type BasePayloadResponse = {
  data?: object
  desc?: string
  retcode?: string

}

/**
 * User Account Controller
 * @class UserAccountAPI
 */
export class UserAccountAPI {
/**
  * changeUserState
  * @method
  * @name UserAccountAPI#changeUserState
  
  * @param  accountUserInfo - accountUserInfo 
  
  * @param $domain API域名,没有指定则使用构造函数指定的
  */
  changeUserState(parameters: {
    'accountUserInfo': AccountUserInfo,
    $queryParameters?: any,
    $domain?: string
  }): Promise<AxiosResponse<BasePayloadResponse>> {

    let config: AxiosRequestConfig = {
      baseURL: parameters.$domain || this.$defaultDomain,
      url: '/userAccount/changeUserState',
      method: 'PUT'
    }

    config.headers = {}
    config.params = {}

    config.headers[ 'Accept' ] = '*/*'
    config.headers[ 'Content-Type' ] = 'application/json'

    config.data = parameters.accountUserInfo
    return axios.request(config)
  }

/**
  * changeUserState
  * @method
  * @name UserAccountAPI#changeUserState
  
  * @param  accountUserInfo - accountUserInfo 
  
  * @param $domain API域名,没有指定则使用构造函数指定的
  */
  async changeUserStateAsync(parameters: {
    'accountUserInfo': AccountUserInfo,
    $queryParameters?: any,
    $domain?: string
  }): Promise<BasePayloadResponse> {

    let resp = await this.changeUserStateAsync(parameters);
    return Promise.resolve(resp.data);
  }

}


/**
 * 管理系统接口描述
 * @class API
 */
export class API {
  /**
   *  API构造函数
   * @param domain API域名
   */
  constructor(domain?: string) {
    this.$defaultDomain = domain || 'http://localhost:8080'
  }

  _UserAccountAPI: UserAccountAPI = null;

  /**
  * 获取 User Account Controller API
  * return @class UserAccountAPI
  */
  getUserAccountAPI(): UserAccountAPI {
    if (!this._UserAccountAPI) {
      this._UserAccountAPI = new UserAccountAPI(this.$defaultDomain)
    }
    return this._UserAccountAPI
  }
}

Use the API Class

import { API } from './api'
// in main.ts
let api = new API('YOUR_API_HOST')
api.withAuthorization("YOUR_TOKEN")
// add Interceptors
api.withInterceptors(
    response => {
        if (response.status === 200) {
            return Promise.resolve(response)
        } else {
            return Promise.reject(response)
        }
    },
    error => {
        if (error.response.status) {
            switch (error.response.status) {
                case 401:
                    console.error("401 Unauthorized")
                    break
                case 403:
                    console.error("403 Forbidden")
                    break
                case 404:
                    console.error("404 Not Found")
                    break
                default:
                    console.error(error.response.data.message)
            }
            return Promise.reject(error.response)
        }
    })

api.getUserAccountAPI().changeUserState({
  isDisable: 1
  openId: 'open id'
}).then(resp=>{
  console.log(resp)
})

Reference

• swagger-js-codegen

License

Apache-2.0 © jadepeng

generator-swagger-2-ts's Issues

执行完成后没有生成文件

泛型支持好像有点问题

泛型返回格式GenericAjaxResult<Page<Location>> ，用工具生成了下面两个类型。其中
Page«Location» 和PageLocation 对不上
export type GenericAjaxResultPageLocation = {
code?: number
data?: Page«Location»
msg?: string
}
export type PageLocation = {
current?: number
orders?: Array
pages?: number
records?: Array
searchCount?: boolean
size?: number
total?: number
}

The "path" argument must be of type string. Received undefined

Misspelled word~

对中文groupName支持不好

如果swagger进行了分组，且组名中有中文，则可能不支持，

当然这可能swagger本身就有问题，对中文group支持不好。

<a target="_blank" href="http://172.16.248.11:9181/smart/v2/api-docs?group="><span class="url"><!-- react-text: 52 --> <!-- /react-text --><!-- react-text: 53 -->http://172.16.248.11:9181/smart/v2/api-docs?group=前端接口<!-- /react-text --><!-- react-text: 54 --> <!-- /react-text --></span></a>

npm包有问题

get请求参数

import API from './api';

declare var require: any;
let service = new API('http://localhost:8090');

let run = async () => await service.fetchAllInPatientsListUsingGET({admissionSn:'20068598'});

run().then(data => console.log(data));

---

参数没生效啊

+1

不支持泛型

此外如果指定了ApiModel，则无法处理对应的class名