0

我们正在记录应用程序中的所有 API，为此我们正在使用swagger UI

这是它的示例代码

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但我们必须将其更改为“/create_people”，所以我们如何实现这个功能。

我们通过更改这里的“路径”来尝试这spec是代码

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

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

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

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

这是图示。在此处输入图像描述

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

4

1 回答 1

0

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

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

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

于 2014-11-11T16:14:25.237 回答