Question

有没有办法在Swagger规范中为参数的name属性设置一个别名，以便SmartDocs显示不同的值？

例如：

parameters:
  - name: consumer_key
    in: formData
    description: >-
    Your Consumer Key (from My Apps)
    required: true
    type: string

发送请求时，实际上发送的是consumer_key = ABC而不是client_id = ABC。我尝试这样做的原因是，开发人员在成功注册开发人员应用程序后将获得consumer_key（作为client_id）。

或者，我可以在说明字段中映射它们＆＃39;此client_id是您应用的consumer_key。＆＃39;或类似的东西，但我想看看是否有办法设置别名＆＃39;对于swagger规范中的名称字段。

Answer 1

Swagger不支持参数的别名。如果文档使用的参数名称与实际请求中的参数名称不同，则可能会使开发人员感到困惑。

使用description来解释参数值的来源。这就足够了。