Swashbuckle Swagger UI：如何从XML注释中的参数中删除必需的

我想在控制器中的某些参数上更改所需的属性.我使用XML注释来链接到Swagger.示例图片here

解决方法:

在继续之前,请仔细考虑您的参数.该参数是否确实需要,您的键入内容是否反映出来？是否有合理的默认值？在这种情况下,预期的行为是什么？根据您的答案,您可能更喜欢以下两种解决方案之一：

选项1：可选参数

如果accessTokenID具有合理的默认值,则可以在API签名上指定该值,并且Swashbuckle将根据需要停止标识该参数.

例如,此示例中的id在Swagger UI中将解析为可选：

public HttpResponseMessage Get(int id = 0)

如果确实不需要参数,则可为空的类型可能更有意义(例如,如果您在空输入中列出所有值)：

public HttpResponseMessage Get(int? id = null)

选项2：SwaggerDefaultValue属性

solution in the Swashbuckle GitHub创建了一个IOperationFilter来处理SwaggerDefaultValue属性并将其应用于Swagger UI.如果您希望使用此参数,但是想在Swagger UI中设置一些默认值,则可以使用此解决方案.

例如,这将在Swagger UI文本字段中显示“ 0”,而不是“((必需)”)：

[SwaggerDefaultValue("id", "0")]
public HttpResponseMessage Get(int id)

标签：swashbuckle,c,swagger-ui
来源： https://codeday.me/bug/20191026/1932693.html