如何从 javascript 访问 swagger yaml 定义的对象

Question

我使用 Swagger Yaml 来描述端点并生成模拟服务器。现有端点（我正在模拟）没有 100% 遵循 RESTful 原则，所以我只想覆盖模拟服务器 returned 的响应。简单服务器代码如下：

var swagger         = require('swagger-server');
var server          = swagger('map-cache.yaml');

var port            = 7072;

server.post('/map-qa_trunk/v2/getData', function(req, res, next) {
    var foo = { 
        err : 123,
        msg : "error message"
    };  
    res.json(foo);
});

server.listen(port, function() {
  console.log('Map Cache Mock Server is now running at http://localhost:' + port);
});

在 Yaml 定义中，定义了一个名为 MapResponseData 的对象，我如何创建该对象的实例以便我可以根据需要填充它，return 在 res.json() ？类似于以下内容：

var response = getMapResponseData(); // don't know what this call should be
response.fieldA = 123;
res.json(response);

我猜这应该是可能的，因为 Swagger 解析了 YAML 文件并且知道指定的所有定义。

Answer 1

尝试将请求对象输出到 console.log 以查看是否可以找到对 swagger 定义的引用。另一种选择是从 yaml 文件中提取已解析的 swagger 定义（例如使用 js-yaml）并从那里提取。

不过，我最好的建议是使用 swagger-tools 而不是 swagger-server。 swagger-server 软件包是 alpha 版本，下载次数、修订次数和用户数少于 swagger-tools。 swagger-tools 的好处是它会得到积极维护，并且有一个更大的社区可以支持你。要将项目转换为 swagger-tools，请使用 swagger.io > Swagger Editor > Online Editor > Paste yaml in left pane > Generate Server > Node.js

在swagger-tools中，整个 Swagger Yaml 定义包含在每个请求对象中：

req.swagger.swaggerObject

您可以根据需要从中提取响应对象定义。

如何从 javascript 访问 swagger yaml 定义的对象

How to access swagger yaml defined objects from javascript

swagger

swagger-ui

swagger-2.0

swagger-editor

swagger-codegen