首页 文章

Swagger-codegen-js没有发现没有翻译api endpoints 上定义的响应模式

提问于
浏览 次
-1

Summary 我正在使用swagger-codegen-js根据外部api定义的swagger.json生成typescript文件 .

packages used "swagger-js-codegen"："^1.12.0"，

Alleged Problem 生成的TS文件上方法 listMovies 上的返回类型只是 Promise<Request.Response> 而不是 Promise<Array<Movie>> ，我确实期望它是电影数组，因为响应清楚地表明了架构和思想/假设将被翻译 .

给出了json沿着以下的线，

"/movies": {
    "get": {
      "description": "Lists movies",
      "operationId": "listMovies",
      "responses": {
        "200": {
          "description": "Movie",
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/Movie"
            }
          }
        },
        "default": {
          "$ref": "#/responses/genericError"
        }
      }
    },
 "definitions": {
  "Movie": {
    "description": "something",
    "type": "object",
    "properties": {
      "archivedAt": {
        "description": "When the movie was archived",
        "type": "string",
        "format": "nullable-date-time",
        "x-go-name": "ArchivedAt",
        "readOnly": true
      }
  }
}

Generated TS Method

/**
 * Lists movies
 * @method
 * @name Api#listMovies
 */
listMovies(parameters: {
    $queryParameters ? : any,
    $domain ? : string
}): Promise <request.Response> {
    const domain = parameters.$domain ? parameters.$domain : this.domain;
    let path = '/movies';
    .
    .
    .
        this.request('GET', domain + path, body, headers, queryParameters, form, reject, resolve);
    });
}

我用来生成上述ts文件的脚本直接来自github示例

const generateTSFilesUsingSwaggerJsCodegen = function () {
var fs = require('fs');
var CodeGen = require('swagger-js-codegen').CodeGen;

var file = 'build/sample.json';
var swagger = JSON.parse(fs.readFileSync(file, 'UTF-8'));
var tsSourceCode = CodeGen.getTypescriptCode({ className: 'Api', swagger: swagger, imports: ['../../typings/tsd.d.ts'] });
fs.writeFileSync('src/api/api.ts', tsSourceCode)

}

我错过了通过电线/选项传递的东西，或者这是给定json文件的预期生成文件，我需要编写自定义脚本来获得我想要的东西？

javascript typescript typescript-typings swagger-codegen

2 回答

  • 2

    这似乎是预期的行为 .

    TypeScript Mustache template输出固定值：

    ...
}): Promise<request.Response> {
    ...
    回复于
  • 0

    只能编辑codegen来改变它 .

    但是你可以只使用返回值的主体

    <restMethod>(<paramters>).then(respose: <request.Response>) {
  let responseObject: Array<ListMovies> = response.body as Array<ListMovies>;
  ...
}

    如果你想改编codegen，从git中取出它并更改以下文件：

    LIB / codegen.js：

    var getViewForSwagger2 = function(opts, type){
var swagger = opts.swagger;
var methods = [];
var authorizedMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'COPY', 'HEAD', 'OPTIONS', 'LINK', 'UNLIK', 'PURGE', 'LOCK', 'UNLOCK', 'PROPFIND'];
var data = {
    isNode: type === 'node' || type === 'react',
    isES6: opts.isES6 || type === 'react',
    description: swagger.info.description,
    isSecure: swagger.securityDefinitions !== undefined,
    moduleName: opts.moduleName,
    className: opts.className,
    imports: opts.imports,
    domain: (swagger.schemes && swagger.schemes.length > 0 && swagger.host && swagger.basePath) ? swagger.schemes[0] + '://' + swagger.host + swagger.basePath.replace(/\/+$/g,'') : '',
    methods: [],
    definitions: []
};

_.forEach(swagger.definitions, function(definition, name){
    data.definitions.push({
        name: name,
        description: definition.description,
        tsType: ts.convertType(definition, swagger)
    });
});

    最后一个_.forEach从方法的底部移动到这里 .

    var method = {
            path: path,
            className: opts.className,
            methodName: methodName,
            method: M,
            isGET: M === 'GET',
            isPOST: M === 'POST',
            summary: op.description || op.summary,
            externalDocs: op.externalDocs,
            isSecure: swagger.security !== undefined || op.security !== undefined,
                          isSecureToken: secureTypes.indexOf('oauth2') !== -1,
                          isSecureApiKey: secureTypes.indexOf('apiKey') !== -1,
                          isSecureBasic: secureTypes.indexOf('basic') !== -1,
            parameters: [],
            responseSchema: {},
            headers: []
        };
        if (op.responses && op.responses["200"]) {
            method.responseSchema = ts.convertType(op.responses["200"], swagger);
        } else {
            method.responseSchema = {
                "tsType": "any"
            }
        }

    这是从第102行开始 . 将responseSchema添加到方法并附加if / else

    templates / typescript-class.mustache（第68行）

    resolve(response.body);

    templates / typescript-method.mustache（第69行）

    }): Promise<{{#responseSchema.isRef}}{{responseSchema.target}}{{/responseSchema.isRef}}{{^responseSchema.isRef}}{{responseSchema.tsType}}{{/responseSchema.isRef}}{{#responseSchema.isArray}}<{{responseSchema.elementType.target}}>{{/responseSchema.isArray}}> {

    这仅适用于简单类型，对象类型和简单/对象类型的数组 . 我没有实现枚举类型 .

    回复于

相关问题