@clementoh/更好-openapi-viewer-ui (英语)

反应UI用于更好的OpenAPI查看器.

发现

取景器使可访问的端点导航与运行计数,文本搜索,以及HTTP方法的过滤器,标记,认证要求,去折旧状态,以及从已规范的OpenAPI文档中获取这些值时的文件内容类型. 它还利用核心的 schema 树辅助器,将组件 schemas 和 Swagger 定义纳入模型部分.

扩展操作显示结构化的请求正体介质类型, schema属性树, 已记录实例, 响应状态类标签, 响应描述, 响应内容实例, 外部 Docs 链接, 以及出现时的回调/ webhook 摘要 。 常见的Markdown风格描述文本作为React文本和元素安全地渲染而未添加Markdown依赖.

试试看吧

扩展的操作包括一个全局可控,可选入的试出面板. 用户可以选择服务器,填充服务器变量,选择请求内容类型,编辑参数值,使用生成的JSON对象请求正体字段控制,上传文件备案 multipart/form-data 二进制字段,检查并复制生成的 URL,正文,以及片断,发送或取消请求 fetch 财务报告和审定财务报表 AbortController,审查响应状态,持续时间,标题,以及正文,复制响应正文,并重置输入回已记录实例/默认.

在发送前,UI报告缺少所需的参数,缺少所需的请求机构或多段字段,以及无效的JSON请求机构.

片段选择器目前暴露出卷曲,由核心卷曲片段生成器支撑.

授权

查看器检测支持 OpenAPI 和 Swagger 安全方案 components.securitySchemes 财务报告和审定财务报表 securityDefinitions。一个全局授权面板允许用户输入 Basic auth 、 Bearer 令牌、 标题、 查询或 cookie 位置的 apiKey 证书, 以及 OAuth/ OpenID 计划中的 Access- token 样式值, 核心请求构建者可以应用无记名证书。 OAuth 流量和 OpenID 连接发现 URL 在被记录时显示. 证书可按计划或全球范围审批.

过 persistAuthorization 以存储当前 API 文件的证书 localStorage。 。 。 .

过 preauthorizedCredentials 或者说 config.preauthorizedCredentials 以种子授权面板,例如:

<BetterOpenApiViewer
  document={document}
  preauthorizedCredentials={{
    bearerAuth: 'token',
    basicAuth: { username: 'demo', password: 'secret' },
  }}
/>

主题

查看器在根 UI 上包含可访问的光和暗主题控件,并用一个 data-theme 属性.