包简介

Generate API documentation for humans from your Laravel codebase.✍

README 文档

README

Scribe helps you generate API documentation for humans from your Laravel codebase. See a live example at demo.scribe.knuckles.wtf.

Features

Useful output:
- Pretty single-page HTML doc, with human-friendly text, code samples, and in-browser API tester ("Try It Out")
- Generates Postman collection and OpenAPI spec (v3.0.3 or v3.1.0)
Smarts. Scribe can:
- extract request parameter details from FormRequests or validation rules
- safely call API endpoints to get sample responses
- generate sample responses from Eloquent API Resources or Transformers
Customizable to different levels:
- Customize the UI by adjusting text, ordering, examples, or changing the UI itself
- Add custom strategies to adjust how data is extracted
- Statically define extra endpoints or information not in your codebase

Tip

👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable, and testable API docs, there are some more things you need to know. So I made a course for you.🤗

Documentation

Check out the documentation at scribe.knuckles.wtf/laravel.

Contributing

Contributing is easy! See our contribution guide.

knuckleswtf/scribe 适用场景与选型建议

knuckleswtf/scribe 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 13.93M 次下载、GitHub Stars 达 2.32k，最近一次更新时间为 2020 年 05 月 03 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「api」「laravel」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 knuckleswtf/scribe 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 knuckleswtf/scribe 我们能提供哪些服务？

定制开发 / 二次开发

基于 knuckleswtf/scribe 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发