Obsidian 插件:Swagger JSON to Markdown
插件名片
概述
插件名称
Swagger JSON to Markdown
主要功能
将 Swagger 2.0 和 OpenAPI 3.x 的 JSON 文件转换为 Swagger 风格的静态 Markdown 文件。
适用场景
适用于需要在 Obsidian 笔记中生成接近 Swagger UI 效果的 API 文档,以及将文档导出为 PDF 的场景。
核心特色
- 支持多种转换模式,如完整文档的
full模式和可复用片段的fragment模式。 - 可通过上下文菜单或命令进行转换,转换前有选项模态框。
- 能按
tags分组操作,可根据tag、operationId等过滤输出。 - 采用真实 Markdown 标题,支持 Obsidian 大纲和 PDF 书签,也可禁用使用 HTML 标题块。
- 生成 API 各部分详细信息,处理 HTML 描述字段,渲染示例,解析
$ref并报告引用警告。
使用建议
手动安装时,将 main.js、manifest.json、styles.css 复制到 VaultFolder/.obsidian/plugins/swaggerjson-to-markdown/ 目录,然后启用插件即可使用。
Help这篇插件文章还没有人贡献,欢迎占坑!
如果您有好的想法欢迎提交PR或者文末留言。
讨论
若阁下有独到的见解或新颖的想法,诚邀您在文章下方留言,与大家共同探讨。
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。