如何获得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后，当文档仅显示getPetById()时，他们如何知道查询GET /pet/{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中，您可以通过单击文档单词部分（展开操作按钮旁边）上的原始按钮来获取swagger.json。您可以在此处找到所有其他swagger.json文件：http://developer.wordnik.com/v4/