scribe

Scribe 可以帮助您从 Laravel 代码库中生成面向人类的 API 文档。请参阅 demo.scribe.knuckles.wtf 的实时示例。

特性

• 有用的输出:
  • 精美的单页 HTML 文档,包含人类可读的文本、代码示例和浏览器内的 API 测试器("试用")。
  • 生成 Postman 集合和 OpenAPI 规范(3.0.3 或 3.1.0 版本)。
• 智能化: Scribe 可以:
  • 从 FormRequests 或验证规则中提取请求参数详细信息。
  • 安全地调用 API 端点以获取示例响应。
  • 从 Eloquent API 资源或转换器生成示例响应。
• 可根据不同级别进行自定义:
  • 通过调整文本、排序、示例或更改 UI 本身来自定义 UI。
  • 添加自定义策略以调整数据提取方式。
  • 静态定义不在代码库中的额外端点或信息。

[!提示] Scribe 可以帮助您自动生成文档,但如果您真的想创建友好、可维护和可测试的 API 文档,还需要了解一些其他内容。因此,我为您制作了 课程。