PHPackages charescape/scribe - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. charescape/scribe ActiveLibrary[API Development](/categories/api) charescape/scribe ================= Generate API documentation for humans from your Laravel codebase.✍ v5.x-dev(3mo ago)0174MITPHP >=8.1 Since Nov 5Pushed 3mo agoCompare [ Source](https://github.com/charescape/scribe)[ Packagist](https://packagist.org/packages/charescape/scribe)[ Docs](https://github.com/knuckleswtf/scribe)[ Patreon](https://patreon.com/shalvah)[ RSS](/packages/charescape-scribe/feed)WikiDiscussions v5 Synced 1mo ago READMEChangelogDependencies (23)Versions (3)Used By (0) [![logo-scribe](logo-scribe.png)](logo-scribe.png) [![Latest Stable Version](https://camo.githubusercontent.com/c45c351502db6cebd23fd944a9beecc7e5647a922142df52d95fc9dc184445bf/68747470733a2f2f706f7365722e707567782e6f72672f6b6e75636b6c65737774662f7363726962652f762f737461626c65)](https://packagist.org/packages/knuckleswtf/scribe)[![Total Downloads](https://camo.githubusercontent.com/17048eb8717656cd705d8c248d8ac6929573d648eca8bb20b87be00561d7346b/68747470733a2f2f706f7365722e707567782e6f72672f6b6e75636b6c65737774662f7363726962652f646f776e6c6f616473)](https://packagist.org/packages/knuckleswtf/scribe)[![Code Style](https://camo.githubusercontent.com/617d03f76aa2eb903d5a5d712c2bf68e3def88332355a9ff52f3bda62f5814e2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70696e742d663538643333)](https://github.com/laravel/pint) Scribe helps you generate API documentation for humans from your Laravel codebase. See a live example at [demo.scribe.knuckles.wtf](https://demo.scribe.knuckles.wtf). Features -------- [](#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](https://shalvah.teachable.com/p/api-documentation-for-developers?utm_source=scribe-laravel&utm_medium=referral&utm_campaign=none) for you.🤗 Documentation ------------- [](#documentation) Check out the documentation at [scribe.knuckles.wtf/laravel](http://scribe.knuckles.wtf/laravel). Contributing ------------ [](#contributing) Contributing is easy! See our [contribution guide](https://scribe.knuckles.wtf/laravel/contributing). ### Health Score 36 — LowBetter than 79% of packages Maintenance80 Actively maintained with recent releases Popularity10 Limited adoption so far Community19 Small or concentrated contributor base Maturity35 Early-stage or recently created project Bus Factor1 Top contributor holds 75.9% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 103d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/53265646?v=4)[charescape](/maintainers/charescape)[@charescape](https://github.com/charescape) --- Top Contributors [![shalvah](https://avatars.githubusercontent.com/u/14361073?v=4)](https://github.com/shalvah "shalvah (1768 commits)")[![mpociot](https://avatars.githubusercontent.com/u/804684?v=4)](https://github.com/mpociot "mpociot (267 commits)")[![charescape](https://avatars.githubusercontent.com/u/53265646?v=4)](https://github.com/charescape "charescape (39 commits)")[![james2doyle](https://avatars.githubusercontent.com/u/1425304?v=4)](https://github.com/james2doyle "james2doyle (24 commits)")[![lucasmichot](https://avatars.githubusercontent.com/u/513603?v=4)](https://github.com/lucasmichot "lucasmichot (21 commits)")[![MarnuLombard](https://avatars.githubusercontent.com/u/2191786?v=4)](https://github.com/MarnuLombard "MarnuLombard (15 commits)")[![zolotov88](https://avatars.githubusercontent.com/u/11463586?v=4)](https://github.com/zolotov88 "zolotov88 (14 commits)")[![gabrielpeixoto](https://avatars.githubusercontent.com/u/3699061?v=4)](https://github.com/gabrielpeixoto "gabrielpeixoto (14 commits)")[![robbieaverill](https://avatars.githubusercontent.com/u/5170590?v=4)](https://github.com/robbieaverill "robbieaverill (14 commits)")[![lloricode](https://avatars.githubusercontent.com/u/8251344?v=4)](https://github.com/lloricode "lloricode (13 commits)")[![ScopeyNZ](https://avatars.githubusercontent.com/u/3260989?v=4)](https://github.com/ScopeyNZ "ScopeyNZ (11 commits)")[![Peterragheb](https://avatars.githubusercontent.com/u/22989662?v=4)](https://github.com/Peterragheb "Peterragheb (10 commits)")[![icarojerry](https://avatars.githubusercontent.com/u/9601443?v=4)](https://github.com/icarojerry "icarojerry (10 commits)")[![ezra-obiwale](https://avatars.githubusercontent.com/u/2762623?v=4)](https://github.com/ezra-obiwale "ezra-obiwale (9 commits)")[![golonix](https://avatars.githubusercontent.com/u/9950778?v=4)](https://github.com/golonix "golonix (8 commits)")[![badmike](https://avatars.githubusercontent.com/u/1019002?v=4)](https://github.com/badmike "badmike (8 commits)")[![090809](https://avatars.githubusercontent.com/u/2166259?v=4)](https://github.com/090809 "090809 (8 commits)")[![phanan](https://avatars.githubusercontent.com/u/8056274?v=4)](https://github.com/phanan "phanan (7 commits)")[![AdamiecRadek](https://avatars.githubusercontent.com/u/8867468?v=4)](https://github.com/AdamiecRadek "AdamiecRadek (6 commits)")[![s-shiryaev](https://avatars.githubusercontent.com/u/33102548?v=4)](https://github.com/s-shiryaev "s-shiryaev (6 commits)") --- Tags apilaraveldocumentation ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/charescape-scribe/health.svg) ``` [![Health](https://phpackages.com/badges/charescape-scribe/health.svg)](https://phpackages.com/packages/charescape-scribe) ``` ### Alternatives [knuckleswtf/scribe Generate API documentation for humans from your Laravel codebase.✍ 2.3k14.2M63](/packages/knuckleswtf-scribe)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[statamic/cms The Statamic CMS Core Package 4.8k3.6M983](/packages/statamic-cms)[darkaonline/l5-swagger OpenApi or Swagger integration to Laravel 3.0k37.6M133](/packages/darkaonline-l5-swagger)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M572](/packages/shopware-core)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M734](/packages/sylius-sylius) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)