Swagger

swagger和openAPI: OpenAPI扩展

OpenAPI扩展 扩展或供应商扩展是自定义属性x-,例如x-logo。它们可以用来描述标准OpenAPI规范没有涉及的额外功能。许多支持OpenAPI的API相关产品都使用扩展来记录自己的属性,例如Amazon API Gateway,ReDoc,AP...

swagger和openAPI: API通用信息

API通用信息 将API的一般信息纳入规范被认为是一种很好的做法:版本号,许可证说明,联系人数据,文档链接等。我们特别建议为公共可用的API执行此操作; 因为这可以增加用户对服务的信心,贵公司提供。 要指定...

swagger和openAPI: 使用$ ref

使用$ ref 在记录API时,通常会使用跨若干API资源使用的某些功能。在这种情况下,您可以为这些元素创建一个片段,以便在需要时多次使用它们。 借助OpenAPI 3.0,您可以引用托管在任何位置的定义。它可以是同...

swagger和openAPI: 组件部分

组件部分 通常,多个API操作具有一些通用参数或返回相同的响应结构。为避免代码重复,您可以将常用定义放置在全局  components部分中并使用它们进行引用$ref。 在下面的示例中,用户对象的重复定义被替换为单...

swagger和openAPI: 回调

回调 在OpenAPI 3规范中,您可以定义回调 - 异步,带外请求,您的服务将响应某些事件发送给其他服务。这可以帮助您改善API向客户提供的工作流程。 回调的一个典型例子是订阅功能 - 用户订阅您服务的某些事件...

swagger和openAPI: 链接

链接是OpenAPI 3.0的新功能之一。使用链接,可以描述一个操作返回的各种值如何用作其他操作的输入。这样,链接提供了操作之间的已知关系和遍历机制。 链接的概念有点类似于超媒体,但OpenAPI链接不需要实际响...

swagger和openAPI: Cookie认证

Cookie认证 Cookie认证使用HTTP cookie来认证客户端请求并维护会话信息。它的工作原理如下: 客户端向服务器发送登录请求。 在成功登录时,服务器响应包括包含cookie名称,值,到期时间和一些其他信息的...

swagger和openAPI: OAuth 2.0

OAuth 2.0 OAuth 2.0是一种授权协议,它允许API客户端有限访问Web服务器上的用户数据。GitHub,Google和Facebook API特别使用它。OAuth依赖称为流的身份验证方案,它允许资源所有者(用户)共享来自资源服务器的...

swagger和openAPI: 承载认证

承载认证 承载认证(也称为令牌认证)是一种HTTP认证方案,涉及称为承载令牌的安全令牌。“承载认证”的名称可以理解为“授予访问该令牌的承载者”。 不记名令牌是一种神秘的字符串,通常由服务器响应登录请求而...

swagger和openAPI: API密钥

API密钥 一些API使用API​​密钥进行授权。API密钥是客户在进行API调用时提供的令牌。密钥可以在查询字符串中发送: GET /something?api_key=abcdef12345 或作为请求标题: GET /something HTTP/1.1 X-API-Key...