leandrodiogenes02/scribe
Composer 安装命令：
composer require leandrodiogenes02/scribe
包简介
Generate API documentation for humans from your Laravel codebase.✍
关键字：
README 文档
README
Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf. There's a Node.js version, too!
Features
- Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
- Extracts body parameters details from FormRequests or validation rules
- Safely calls API endpoints to get sample responses
- Supports generating responses from Transformers or Eloquent API Resources
- Generates Postman collection and OpenAPI spec
- Easily customisable with custom views and included UI components
- Easily extensible with custom strategies
- Statically define extra endpoints that aren't in your codebase
👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made a course for you.🤗
Documentation
Check out the documentation at scribe.knuckles.wtf/laravel.
v2 docs (PHP 7.2+, not actively maintained) are at scribe.rtfd.io.
If you're coming from mpociot/laravel-apidoc-generator, there's a migration guide.
Contributing
Contributing is easy! See our contribution guide.
leandrodiogenes02/scribe 适用场景与选型建议
leandrodiogenes02/scribe 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 19 次下载、GitHub Stars 达 0， 最近一次更新时间为 2021 年 12 月 24 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「documentation」 「api」 「laravel」 「dingo」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 leandrodiogenes02/scribe 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 leandrodiogenes02/scribe 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 leandrodiogenes02/scribe 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting
Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.
A PSR-7 compatible library for making CRUD API endpoints
Laravel API documentation generating tool
Alfabank REST API integration
RESTful API server for structured and self-documenting resources over JSON, XML, ...
统计信息
- 总下载量： 19
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 0
- 点击次数： 1
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2021-12-24