所以我遇到了一个有趣的案例,我需要为REST API生成swagger文档,其唯一的文档是实际文档(没有内联XML文档),并且我没有直接的源代码访问权限。所以我简单地写了一个包装器控制器,并覆盖每条路径:
[HttpGet("this/{that}/the/{other}")]
public override IActionResult GetWhatever(String that, String other) => base.GetWhatever(that, other);
然后,用标准的摘要标签等来记录它。但是,现在被覆盖的方法之一在内部使用查询字符串,并且不作为[FromQuery]的参数公开,因此它不能被反射地自动记录(和在没有实际参数的情况下为它添加标签不会为其生成文档)
我需要一种方法来手动添加此参数文档,但通过代码以某种方式(不仅仅是通过将其添加到swagger.json文件)。我虽然可以使用SwaggerGen的ISchemaFilter为相关的路由/方法添加参数描述,但到目前为止我没有太多运气。
有没有人有这样做的例子?
所以看起来我正在寻找的是IOpertationFilter。将它与自定义属性相结合,我能够创建我需要手动将自定义参数添加到Swagger文档中的动态。请参阅下面的所有相关代码,请注意Schema / PartialSchema有很多属性,我只设置Type就像我需要的一样,其他情况可能需要更多。
SwaggerParameterAttribute.cs
using System;
using Microsoft.AspNetCore.Mvc.Filters;
using Swashbuckle.AspNetCore.Swagger;
/// <summary>
/// Types of Swagger parameters
/// </summary>
public enum SwaggerParamType {Body, NonBody};
/// <summary>
/// Attribute to facilitate manually adding a parameter to auto-generated Swagger documentation
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class SwaggerParameterAttribute : ActionFilterAttribute {
/// <summary>
/// Swagger parameter to inject
/// </summary>
public IParameter Parameter { get; set; }
/// <summary>
/// Default constructor
/// </summary>
/// <param name="ParamType">Type of Swagger parameter (Body/NonBody)</param>
/// <param name="Name">Name of the parameter</param>
/// <param name="Type">Primitive type associated with the parameter (int, bool, string, etc.)</param>
/// <param name="In">Location of the parameter (path, query, etc.)</param>
/// <param name="Description">Description of the parameter</param>
/// <param name="Required">Whether the parameter is required or not (true/false)</param>
public SwaggerParameterAttribute(SwaggerParamType ParamType, String Name, String Type, String In, String Description = "", Boolean Required = false){
switch (ParamType) {
case SwaggerParamType.Body:
Parameter = new BodyParameter() { Name = Name, In = In, Description = Description, Required = Required, Schema = new Schema() { Type = Type } };
break;
case SwaggerParamType.NonBody:
Parameter = new NonBodyParameter() { Name = Name, In = In, Description = Description, Required = Required };
((PartialSchema)Parameter).Type = Type;
break;
default:
throw new ArgumentOutOfRangeException("Invalid Swagger parameter type specified.");
}
}
SwaggerOperationFilter.cs
using System;
using System.Reflection;
using Microsoft.AspNetCore.Mvc.Controllers;
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
using Whatever.NameSpace.Your.Attribute.Is.In;
/// <summary>
/// Custom Swagger Operation Filter
/// </summary>
public class SwaggerOperationFilter : IOperationFilter {
public void Apply(Operation operation, OperationFilterContext context) {
//Check for [SwaggerParameter] add defined parameter to the parameter list
foreach (Attribute attribute in ((ControllerActionDescriptor)context.ControllerActionDescriptor).MethodInfo.GetCustomAttributes()) {
if (attribute.GetType() == typeof(SwaggerParameterAttribute)) {
operation.Parameters.Add(((SwaggerParameterAttribute)attribute).Parameter);
}
}
}
}
Startup.cs(只是招摇操作过滤器部分)
using Swashbuckle.AspNetCore.Swagger;
using Whatever.NameSpace.Your.Filter.Is.In;
public void ConfigureServices(IServiceCollection services) {
services.AddSwaggerGen(options => {
options.OperationFilter<SwaggerOperationFilter>();
}
}
SomeController.cs(示例用法)
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
using Whatever.NameSpace.Your.Attribute.Is.In;
[HttpGet("this/{that}/the/{other}")]
[SwaggerParameter(ParamType: SwaggerParamType.NonBody, Name: "param1", Type: "string", In: "query", Description: "Some description of param1 here")]
[SwaggerParameter(SwaggerParamType.NonBody, "param2", "string", "query", "Some description of param2 here")]
public override IActionResult GetWhatever(String that, String other) => base.GetWhatever(that, other);