openapi-generator

[![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][codecov-image]][codecov-url] [![David deps][david-image]][david-url] [![Known Vulnerabilities][snyk-image]][snyk-url] [![npm download][download-image]][down

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
openapi-generator
1410.1.394 years ago6 years agoMinified + gzip package size for openapi-generator in KB

Readme

openapi-generator
!NPM versionnpm-imagenpm-url !build statustravis-imagetravis-url !Test coveragecodecov-imagecodecov-url !David depsdavid-imagedavid-url !Known Vulnerabilitiessnyk-imagesnyk-url !npm downloaddownload-imagedownload-url
Quick View
openapi-generator from swagger 2.0 or OpenAPI 3.0:

Simple

openapi-generator url http://xxx/v2/api-docs -c true

Use Config

openapi-generator config ./xxx.js or openapi-generator config ./xxx.json
Config interface:
interface CliConfig {
  api: string;

  /** dir for openapi-generator */
  sdkDir: string;
  /** path of service template */
  templatePath?: string;
  /** path of interface template */
  interfaceTemplatePath?: string;
  /** request lib */
  requestLib = true;
  /** filename style, true 为大驼峰,lower 为小驼峰 */
  camelCase?: boolean | 'lower' = false;
  /** gen type */
  type?: 'ts' | 'js' = 'ts';
  /** service type */
  serviceType?: 'function' | 'class' = 'function';
  /** namespace of typings */
  namespace?: string = 'API';
  /** 自动清除旧文件时忽略列表 */
  ignoreDelete: string[] = [];
}

genAPISDK

function genAPISDK(data: RouteMetadataType[], config: GenConfig) => void