核心用法
AutEng Docs Curl Publish 是一个命令行工具类技能,允许用户通过简单的 HTTP POST 请求将 Markdown 内容发布为可分享的在线文档。主要面向开发者和技术写作者,提供无需登录、纯命令行操作的工作流。
基础调用方式:
- 端点:
https://auteng.ai/api/tools/docs/publish-markdown/ - 必需参数:
markdown(Markdown 文本内容) - 可选参数:
title(文档标题)、expires_hours(过期时间,默认可能为永久或系统默认值)
高级特性:
- Mermaid 图表支持:包括组件图(component diagrams)、流程图(flowcharts)、时序图(sequence diagrams)等
- KaTeX 数学公式:科学和技术文档的公式渲染
- 代码块高亮:保留原始代码格式和语法着色
常用命令模式:
1. 标准发布(交互式输入 JSON)
2. 管道式单文件发布(配合 jq 提取 share_url)
3. 紧凑输出模式(提取 title、share_url、expires_at)
错误处理:任何不包含 share_url 的响应都应视为错误,需输出完整 JSON 以排查问题。
显著优点
- 零配置使用:无需注册账号、无需 API Key、直接 curl 调用
- 丰富渲染支持:原生支持开发者常用的 Mermaid 图表和数学公式
- Unix 哲学友好:管道化设计,完美配合 shell 脚本和 CI/CD 流程
- 快速分享:生成短链接便于即时传播技术文档
- 过期控制:可设置自动过期时间,适合临时文档分享
潜在缺点与局限性
- 服务端依赖:完全依赖 auteng.ai 服务的可用性,无离线能力
- 隐私风险:Markdown 内容需上传至第三方服务器,敏感文档不适合
- 无版本管理:发布后无法修改,只能重新生成链接
- 容量限制未知:文档大小上限、请求频率限制未明确说明
- 持久性不确定:免费服务的长期可用性存疑
- 无访问控制:生成的链接理论上可被任何人访问
适合人群
- 开发者快速分享 API 文档、架构设计图
- 运维人员发布临时部署说明或 Runbook
- 技术写作者在社区或聊天工具中传播格式化内容
- CI/CD 流程中自动生成并发布构建报告
常规风险
| 风险类型 | 说明 | 缓解建议 |
|---------|------|---------|
| 数据泄露 | 敏感代码、配置信息上传至第三方 | 仅用于公开或脱敏内容 |
| 服务中断 | 第三方服务不可用导致功能失效 | 关键文档应有本地备份 |
| 链接失效 | 文档可能被删除或过期 | 重要内容及时迁移至自有平台 |
| 注入攻击 | 若服务端渲染存在漏洞可能影响安全 | 避免上传不可信来源的内容 |
| 合规问题 | 企业数据外传可能违反安全政策 | 企业用户需评估后再使用 |