Documentation 如何在Swagger UI中为请求/响应提供示例数据?
我正在用WebAPI 2和OWIN开发一个web服务。我的目标是使用Swashback添加一些文档 按照我的方法:Documentation 如何在Swagger UI中为请求/响应提供示例数据?,documentation,asp.net-web-api2,swagger,swagger-ui,swashbuckle,Documentation,Asp.net Web Api2,Swagger,Swagger Ui,Swashbuckle,我正在用WebAPI 2和OWIN开发一个web服务。我的目标是使用Swashback添加一些文档 按照我的方法: // ///拉米娅描述。。。 /// ///识别 ///乌纳利斯塔酒店 [HttpPut] [路由(“~/api/v1/documents/{id}/attribute”)] 公共IHttpActionResult Put(整数id,列表 如何自定义自动生成的数据,使图片中的JSON如下所示: [ { "label": "Etichetta di esempio",
//
///拉米娅描述。。。
///
///识别
///乌纳利斯塔酒店
[HttpPut]
[路由(“~/api/v1/documents/{id}/attribute”)]
公共IHttpActionResult Put(整数id,列表
如何自定义自动生成的数据,使图片中的JSON如下所示:
[
{
"label": "Etichetta di esempio",
"value": "Valore di esempio"
}
]
我建议您使用,而不是虚张声势。
您只需使用如下xml示例注释装饰definition属性:
公共类属性为
{
[JsonIgnore]
公共int Id{get;set;}
[JsonIgnore]
public int OtherId{get;set;}
///埃森皮奥竞技场
公共字符串标签{get;set;}
///埃森皮奥谷
公共字符串值{get;set;}
}
这是为了虚张声势,但尚未合并:
Swagger Net是我的招摇过市工具,但我已经合并了许多不错的功能并修复了许多bug。一个选项是使用ISchemaFilter(位于Swagger config.cs上),下面是一个示例:
私有类ApplySchemaVendorExtensions:ISchemaFilter
{
public void Apply(架构、架构注册表、架构注册表、类型)
{
if(schema.properties!=null)
{
foreach(schema.properties中的var p)
{
开关(p键)
{
案例“标签”:
p、 Value.example=“Etichetta di esempio”;
打破
案例“值”:
p、 Value.example=“Valore di esempio”;
打破
}
打破
}
}
}
}
我个人不喜欢这种解决方案,因为我们必须在两个不同的文件中维护一个类的信息…当问题是针对某个特定工具的解决方案时,建议使用不同的工具并没有多大帮助。