如何获取 Swagger API JS 函数名？

Question

我是 Wordnik and Swagger in general. I'm interacting with it through the 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/{petId}，他们怎么知道查询getPetById()函数的函数？

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

如何找到 Swagger APIs 的 JS 函数？

Answer 1

JavaScript方法名与Swagger文档中每个操作的nicknameand/oroperationId字段相同，具体取决于哪个可用。

这是来自 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/

如何获取 Swagger API JS 函数名？

How to get Swagger API JS function names?

javascript

node.js

swagger

swagger-ui