[我正在将ASP.NET Core 3.0与Swashbuckle 5一起使用。我试图在ASP.NET Core 3.0中为ISchemaFilter
编写一个ProblemDetails
。 ProblemDetails
返回了许多不同的状态代码,例如400、401、403、406、415、500等。我想根据状态代码提供ProblemDetails
的其他示例。我该如何实现?这是我写的一些入门代码,只需要填写空白:
public class ProblemDetailsSchemaFilter : ISchemaFilter
{
private static readonly OpenApiObject Status400ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.1"),
["title"] = new OpenApiString("Bad Request"),
["status"] = new OpenApiInteger(StatusCodes.Status400BadRequest),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
["errors"] = new OpenApiObject()
{
["property1"] = new OpenApiArray()
{
new OpenApiString("The property field is required"),
},
},
};
private static readonly OpenApiObject Status401ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7235#section-3.1"),
["title"] = new OpenApiString("Unauthorized"),
["status"] = new OpenApiInteger(StatusCodes.Status401Unauthorized),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status403ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.3"),
["title"] = new OpenApiString("Forbidden"),
["status"] = new OpenApiInteger(StatusCodes.Status403Forbidden),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status404ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.4"),
["title"] = new OpenApiString("Not Found"),
["status"] = new OpenApiInteger(StatusCodes.Status404NotFound),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status406ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.6"),
["title"] = new OpenApiString("Not Acceptable"),
["status"] = new OpenApiInteger(StatusCodes.Status406NotAcceptable),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status409ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.8"),
["title"] = new OpenApiString("Conflict"),
["status"] = new OpenApiInteger(StatusCodes.Status409Conflict),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status415ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.5.13"),
["title"] = new OpenApiString("Unsupported Media Type"),
["status"] = new OpenApiInteger(StatusCodes.Status415UnsupportedMediaType),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status422ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc4918#section-11.2"),
["title"] = new OpenApiString("Unprocessable Entity"),
["status"] = new OpenApiInteger(StatusCodes.Status422UnprocessableEntity),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
private static readonly OpenApiObject Status500ProblemDetails = new OpenApiObject()
{
["type"] = new OpenApiString("https://tools.ietf.org/html/rfc7231#section-6.6.1"),
["title"] = new OpenApiString("Internal Server Error"),
["status"] = new OpenApiInteger(StatusCodes.Status500InternalServerError),
["traceId"] = new OpenApiString("00-982607166a542147b435be3a847ddd71-fc75498eb9f09d48-00"),
};
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (context.ApiModel.Type == typeof(ProblemDetails))
{
// TODO: Set the default and example based on the status code.
// schema.Default = ???;
// schema.Example = ???;
}
}
}
这里是一个简单的解决方法,如下所示:
1.Model:
public class ProblemDetails
{
public int ID { get; set; }
public string Description { get; set; }
}
2.ProblemDetailsSchemaFilter:
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (context.ApiModel.Type == typeof(ProblemDetails))
{
// TODO: Set the default and example based on the status code.
schema.Default = new OpenApiObject
{
["ID"] = new OpenApiInteger(2),
["Description"] = new OpenApiString("test")
};
schema.Example = new OpenApiObject
{
["ID"] = new OpenApiInteger(1),
["Description"] = new OpenApiString("test test")
};
}
}
3.Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
c.SchemaFilter<ProblemDetailsSchemaFilter>();
});
}