当前位置: 首页 > 知识库问答 >
问题:

什么是昂首阔步,它与OData有关系吗?

欧阳正谊
2023-03-14

我熟悉Microsoft堆栈。我将OData用于我的一些restful服务。最近,我在API文档中遇到了Swagger,我试图了解它与OData的关系。它们似乎都是RESTful规范。哪一种应用广泛?

共有1个答案

宗政文彬
2023-03-14

Swagger是一个用于记录API的规范。通过为API创建一个swagger文档,您可以将其传递给swagger UI的一个实例,该实例以简洁、可读的格式呈现文档,并提供调用API的工具。有关更多信息,请参见Swagger.io网站。

OData是用于通过http创建数据服务的规范,它定义了服务应该如何构造以及应该遵循什么模式。例如,使用$top指令提供数据集的前n个结果。OData目前是第4版,但v2文档有一个非常好的概述。

Swashbuckle是一个用于Microsoft堆栈的nuget包,它根据检查代码和额外的元数据,自动为您的API生成swagger文档,以塑造输出文档。

OpenAPI是描述API的规范;Swagger是OpenAPI标准的实现。你可以在这里找到更多细节。

我希望这有助于澄清任何困惑。

 类似资料:
  • 问题内容: 我想知道如何用昂扬的方式记录枚举。 根据JavaDoc 数据类型。请参阅文档以获取受支持的数据类型。如果数据类型是自定义对象,请设置其名称,或不设置任何名称。如果是枚举,请为枚举常量使用’string’和allowableValues。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 第一服务 第二服务 输入项 天 输出量 pom.xml 您可以在此处查看结果。 我看到

  • 数据类型。有关支持的数据类型,请参见文档。如果数据类型是自定义对象,请设置它的名称,或者不设置任何名称。对于枚举,使用'string'和allowableValues作为枚举常量。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 你可以在这里看到结果。 我认为是个问题... 你知道吗?

  • 我们正在为我们的Laravel REST API实现开发Swagger文档。几个POSTendpoint将使用CSV作为参数内容类型。 Swagger中是否有一种方法可以让“立即尝试”功能与CSV POST文件上传一起使用? 下面是我们的留档http://api.curvecompass.com/docs/#/ 我们的Laravel POST函数可以正确地与CSVendpoint一起工作,而不是与

  • 问题内容: 我正在尝试使用swagger定义post端点,但是不允许使用该参数: 当我跑步时,我得到这个: 我的规格有什么问题? 问题答案: 您可能正在混合使用OpenAPI / Swagger 2.0和OpenAPI 3.0语法。您的规格似乎是2.0,但是关键字是3.0功能。在2.0中,请求正文被定义为正文参数: 更多信息:描述请求正文

  • 这不是springfox的故事,这是springdoc-openapi的故事。 我当前的依赖项 我的物业 此处请求(localhost:8080/swagger-ui.html)我的服务器响应swagger-petstore示例我已经知道petstore-disable(springdoc.swagger-ui.disable-swagger-default-url=true),但它不起作用 另一

  • 我如何指出在my_object中可以有property_1或property_2,但不能两者都有?