列出API时更改API路径名称

Question

我们正在使用swagger UI

来记录应用程序中的所有API

以下是它的示例代码

exports.people = {
  'spec':
  {
    path : "/people",
    method: "POST",
    summary : "Create new person",
    notes : "Create new person",
    nickname : "people",    
    parameters : [param.query("email", "email", "string", true), 
                  param.query("firstName", "firstName", "string", true),
                  param.query("lastName", "lastName", "string", true)]   
  },
  'action': function(req, res)
  {

        -----code----
  }
}

它生成请求URL为

http://localhost:8080/rest/api/people

因此它为/people人们创造了路径，但我们必须将其更改为＆＃34; / create_people＆＃39;那么我们如何实现这一功能呢。

我们通过改变＆＃34;路径＆＃34; spec这里是代码

exports.people = {
  'spec':
  {
    path : "/create_people",
    .....// rest of code

它正在运行，但它创建了不同的重定向网址，如下所示

http://localhost:8080/rest/api/create_people 

这是错误的我们只需要更改API名称而不是请求URL。

这是图形表示。

我们正在使用 swagger-ui 和 node.js

Answer 1

我首先要说这通常不是一个好主意。该文档的目的是向用户解释可用的操作，并在此处隐藏直接信息。毕竟，您在该列的右侧有“创建新人”的描述。

将它放在一边，用Swagger 1.2完成它并不是一件容易的事。您必须破解Swagger文档和UI才能获得所需的输出。您可能想要使用被黑客规范的其他第三方工具也可能无法正常工作。

在Swagger 2.0中，您可以使用x-扩展程序属性，并使用类似"x-alternative-display": "/create_person"的内容，然后您可以更改UI，以便它使用该属性而不是显示路径。