如何记录OData端点(swagger,swashbuckle,other)?

时间:2015-08-05 13:29:23

标签: odata swagger swagger-ui swagger-2.0 swashbuckle

记录OData端点的最佳方法是什么? 有没有办法使用Swashbuckle呢?

5 个答案:

答案 0 :(得分:7)

是的,请尝试Swashbuckle.OData。它为ODataControllers添加了Swashbuckle支持。

在此处查看此行动:http://swashbuckleodata.azurewebsites.net/swagger

答案 1 :(得分:3)

是的,我们正试图像yaml一样支持它 - > Swagger,yaml - > csdl ..

但是需要时间来实施,你可以看到原型并跟踪https://github.com/OData/model-first

答案 2 :(得分:3)

我实际上使用Swashbuckle中的IDocumentFilter函数为此工作。我在Swashbuckle的GitHub回购中回答了类似的问题。在这里查看我的回复(它位于底部或底部):

https://github.com/domaindrivendev/Swashbuckle/issues/149

我发布了一个工作IDocumentFilter实现的示例,您可以利用它来在Swagger ui中设置OData端点。

答案 3 :(得分:1)

Asp NET和Asp NET Core Api版本化

对于 ApiExplorer WebApi Api Versioning(扩展了AspNetCore和Odata信息) >。

有两种样品可供选择:

sample Swashbuckle / Swagger ui 集成得很好。

答案 4 :(得分:0)

我发现最简单的方法是使用https://github.com/oasis-tcs/odata-openapi将OData定义转换为Open API规范,然后才能够导入此类文档。