javascript - 如何获取 Swagger API JS 函数名称？

Question

我是 Wordnik 的新手和 Swagger一般来说。我通过 Node.js JS module 与它交互.

查看生成的 Swagger UI 页面时，例如示例 Petstore Swagger一:

在查询服务器时很难判断 JavaScript 函数应该是什么。

通过 JavaScript 函数，我的意思是类似于 Petstore 示例(来自 swagger-js 文档):

var Swagger = require('swagger-client');

var client = new Swagger({
  url: 'http://petstore.swagger.io/v2/swagger.json',
  success: function() {
    client.pet.getPetById({petId:7},{responseContentType: 'application/json'},function(pet){
      console.log('pet', pet);
    });
  }
});

连接到 swagger.json 后，当文档仅显示 GET/pet/{ 时，他们如何知道查询 getPetById() 函数的函数petId}？

使用 Wordnik API 时，我发现使用 get{DATATYPE}() 函数是一条一般经验法则(将 {DATATYPE} 替换为当然，是一个合适的值)，但该模式已被 getPronunciation() 破坏——它不起作用。我不相信文档在任何地方都这么说。

如何找到 Swagger API 的 JS 函数？

Answer 1

JavaScript 方法名称与 Swagger 文档中每个操作的 nickname 和/或 operationId 字段相同，具体取决于可用的操作。

这是 Wordnik 中的示例:

"path": "/word.{format}/{word}/pronunciations",
"description": "",
"operations": [
    {
    ...
    "nickname": "getTextPronunciations",
    "responseClass": "List[TextPron]"
    }
  ]
},

在此示例中，getTextPronunciations 是 JS 方法名称。

在 Wordnik 中，您可以通过单击文档的 word 部分上的 Raw 按钮(位于“展开操作”按钮旁边)来获取 swagger.json。您可以在此处找到所有其他 swagger.json 文件:http://developer.wordnik.com/v4/