文档校验指南 📄🔍

欢迎使用 Project B 的文档校验工具！本工具可帮助开发者快速验证 API 文档格式、内容完整性及规范性，确保文档质量 🚀

校验功能清单 ✅

• 格式校验：自动检测 YAML/JSON 格式错误
• 内容完整性检查：验证必填字段（如 title, description）是否存在
• 规范性审核：符合 OpenAPI 3.0 标准（含路径、请求参数、响应示例等）
• 多语言支持：可切换中英文文档校验规则 🌍🇺🇸

使用步骤 🧰

1. 安装依赖

   pip install project_b-validator
   

2. 执行校验命令

   validator --input docs/api.yaml --output report.md
   

3. 查看校验报告
   📁 校验结果将生成 report.md 文件，包含详细错误列表

常见问题 FAQ ❓

• Q: 校验失败如何处理？
  A: 点击 校验报告详情 查看具体错误提示

• Q: 支持哪些文档格式？
  A: 目前支持 YAML 和 JSON 格式，更多格式支持敬请期待 📈

扩展阅读 📚

如需了解文档编写规范，可访问 Project B 文档标准 获取详细指南