如何在 Swagger UI 中隐藏参数的 defaultValue？答案

【问题标题】：How can I hide a parameter's defaultValue in Swagger UI?如何在 Swagger UI 中隐藏参数的 defaultValue？
【发布时间】：2015-02-18 12:57:12
【问题描述】：

我将 Swagger 格式直接放在我的 Ruby API 源中并使用 Source2Swagger 创建文档：

# ~ a = my_api.apis.add
# ~ a.set :path => "/my_api/{application_key}"
# ~ op = a.operations.add
# ~ op.set :httpMethod => "GET", :nickname => "getmyapi"
# ~ op.summary = "Get stuff from My API"
# ~ op.parameters.add :name => "application_key", :description => "User authentication token", :dataType => "string", :allowMultiple => false, :required => false, :paramType => "path", :defaultValue => "1234567890"
# ~ op.responseMessages.add :message => "No stuff found", :code => 204
# ~ op.responseMessages.add :message => "API down", :code => 500
#
get '/my_api/?:application_key?', :provides => :json do
  Do stuff...
end

“application_key”不是必需的，但用户需要知道 API 上线时的选项。正如您在上面看到的，我被要求提供一个内部使用的默认值（请不要问为什么:-)）但我仍然想在显示文档时隐藏参数的默认值。这可能吗？

【问题讨论】：

对不起，我已经删除了我的答案，因为我注意到您需要它才能在 swagger ui 上工作。（我的回答不符合）

标签： ruby swagger

【解决方案1】：

如果不破解 UI，您将无法做到这一点。您需要找到该特定操作和该特定参数并覆盖其行为。

如果你仔细想想，你所问的并没有多大意义。您是说系统要求您以一种方式记录某些内容，但在显示文档时，您希望以不同的方式显示它。

当然还有其他可能的解决方案，例如代理您的文档并在代理处更改它，但这可能比它的价值更多。

【讨论】：