fiware/fabre
fiware
自动构建
FIWARE API蓝图渲染工具，用于解析FIWARE规范文件并生成HTML页面或PDF文档，支持自定义模板，助力API文档的可视化展示与分享。
下载次数: 0状态：自动构建维护者：fiware仓库类型：镜像最近更新：9 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Fiware API蓝图渲染器
https://github.com/Fiware/tools.Fabre/blob/master/LICENSE https://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/Fabre_style_guide https://hub.docker.com/r/fiware/fabre/ http://ask.fiware.org https://travis-ci.org/Fiware/tools.Fabre
用于解析FIWARE规范文件并将其渲染为HTML页面的工具，支持生成PDF格式文档，便于API文档的可视化展示与分享。
快速开始指南（使用Docker）
本部分假设您已在机器上安装Docker。若未安装，请按照操作系统说明从https://docs.docker.com/engine/installation/%E8%BF%9B%E8%A1%8C%E5%AE%89%E8%A3%85%E3%80%82
使用Docker镜像运行FABRE
若您的API Blueprint文件路径为/Users/myusername/example_project/myspecification.apib，且希望将生成的站点保存到/Users/myusername/html/example_project文件夹，可执行以下命令：
docker run -it --rm -v /Users/myusername/example_project:/apib -v /Users/myusername/html:/html fiware/fabre -i /apib/myspecification.apib -o /html/example-project
若需使用特定版本（如0.3.1.1），可执行：
docker run -it --rm -v /Users/myusername/example_project:/apib -v /Users/myusername/html:/html fiware/fabre:0.3.1.1 -i /apib/myspecification.apib -o /html/example-project
依赖项
- https://www.python.org/
- http://jinja.pocoo.org/
- Python Markdown
- https://github.com/daGrevis/mdx_linkify
- https://github.com/apiaryio/drafter/tree/v0.1.9
- http://wkhtmltopdf.org/
测试依赖项
- lxml
- https://github.com/SimonSapin/cssselect/
- https://github.com/gawel/pyquery/
安装步骤
-
安装Drafter解析器
需先安装API Blueprint解析器Drafter 0.1.9版本：git clone --recursive --branch v0.1.9 --depth 1 git://github.com/FiwareULPGC/drafter.git cd drafter ./configure make drafter sudo make install -
安装wkhtmltopdf
生成PDF需安装wkhtmltopdf，可从http://wkhtmltopdf.org/downloads.html%E4%B8%8B%E8%BD%BD%E5%AE%89%E8%A3%85%E7%A8%8B%E5%BA%8F%E3%80%82 -
安装FABRE
下载并作为PIP包安装：git clone git://github.com/Fiware/tools.Fabre.git cd tools.Fabre sudo python setup.py install
核心功能与使用场景
核心功能
- 解析FIWARE规范文件生成HTML页面
- 支持生成PDF格式文档
- 允许自定义渲染模板
- 提供调试模式保留临时文件
使用场景
- API文档可视化展示
- 规范文件转换为可分享的HTML/PDF格式
- 开发阶段调试API规范
配置说明
FABRE支持以下命令行选项：
- -i/--input：FIWARE规范文件路径
- -o/--output：输出目录（或PDF文件名，若使用
--pdf） - --pdf：生成PDF文件
- -t/--template：自定义模板路径
- --no-clear-temp-dir：保留临时文件（调试用）
示例：
生成PDF文件：
fabre -i apib_example/fiware_ngsi_v2.apib -o ~/out/output.pdf --pdf
Docker部署扩展
关于构建自定义FABRE镜像的说明，请参考HOW_TO_USE_FABRE_WITH_DOCKER。
故障排除
故障排除指南请参考TROUBLESHOOTING，或通过[***]
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull fiware/fabre:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"