PHPackages                             metafox/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. metafox/scribe

ActiveLibrary[API Development](/categories/api)

metafox/scribe
==============

Generate API documentation for humans from your Laravel codebase.✍

4.22.2(6mo ago)08.9k↑37.5%MITPHPPHP &gt;=8.1

Since May 15Pushed 4mo agoCompare

[ Source](https://github.com/metafoxapp/scribe)[ Packagist](https://packagist.org/packages/metafox/scribe)[ Docs](http://github.com/knuckleswtf/scribe)[ Patreon](https://patreon.com/shalvah)[ RSS](/packages/metafox-scribe/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (24)Versions (108)Used By (0)

Scribe
======

[](#scribe)

[![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)

 [![](logo-scribe.png)](logo-scribe.png)

> [v5 is out now](https://scribe.knuckles.wtf/laravel/migrating)!

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
- 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
- Customisable to different levels:
    - Customise the UI by adjusting text, ordering, examples, or change the UI itself
    - Add custom strategies to adjust how data is extracted
    - Statically define extra endpoints or information that isn'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](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

52

—

FairBetter than 96% of packages

Maintenance71

Regular maintenance activity

Popularity23

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity81

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 75.6% 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

Every ~19 days

Recently: every ~335 days

Total

105

Last Release

194d ago

Major Versions

2.7.7 → 3.0.12021-06-08

2.7.9 → 3.0.22021-06-11

2.7.10 → 3.3.22021-06-30

v2.x-dev → 3.9.02021-08-21

3.26.0 → v4.22.12023-07-26

PHP version history (4 changes)1.0.0-betaPHP &gt;=7.2.5

3.0.0PHP &gt;=7.4

v4.22.1PHP &gt;=8.0

4.22.2PHP &gt;=8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/24b5e29c3654cf6708d0ff86bff354c5d419268d1595d3f48568fe0b137697ae?d=identicon)[metafox](/maintainers/metafox)

---

Top Contributors

[![shalvah](https://avatars.githubusercontent.com/u/14361073?v=4)](https://github.com/shalvah "shalvah (1621 commits)")[![mpociot](https://avatars.githubusercontent.com/u/804684?v=4)](https://github.com/mpociot "mpociot (267 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)")[![robbieaverill](https://avatars.githubusercontent.com/u/5170590?v=4)](https://github.com/robbieaverill "robbieaverill (14 commits)")[![gabrielpeixoto](https://avatars.githubusercontent.com/u/3699061?v=4)](https://github.com/gabrielpeixoto "gabrielpeixoto (14 commits)")[![zolotov88](https://avatars.githubusercontent.com/u/11463586?v=4)](https://github.com/zolotov88 "zolotov88 (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)")[![icarojerry](https://avatars.githubusercontent.com/u/9601443?v=4)](https://github.com/icarojerry "icarojerry (10 commits)")[![Peterragheb](https://avatars.githubusercontent.com/u/22989662?v=4)](https://github.com/Peterragheb "Peterragheb (10 commits)")[![ezra-obiwale](https://avatars.githubusercontent.com/u/2762623?v=4)](https://github.com/ezra-obiwale "ezra-obiwale (9 commits)")[![090809](https://avatars.githubusercontent.com/u/2166259?v=4)](https://github.com/090809 "090809 (8 commits)")[![badmike](https://avatars.githubusercontent.com/u/1019002?v=4)](https://github.com/badmike "badmike (8 commits)")[![golonix](https://avatars.githubusercontent.com/u/9950778?v=4)](https://github.com/golonix "golonix (8 commits)")[![phanan](https://avatars.githubusercontent.com/u/8056274?v=4)](https://github.com/phanan "phanan (7 commits)")[![MissaelAnda](https://avatars.githubusercontent.com/u/31199350?v=4)](https://github.com/MissaelAnda "MissaelAnda (6 commits)")[![AdamiecRadek](https://avatars.githubusercontent.com/u/8867468?v=4)](https://github.com/AdamiecRadek "AdamiecRadek (6 commits)")[![sangnguyenplus](https://avatars.githubusercontent.com/u/6972407?v=4)](https://github.com/sangnguyenplus "sangnguyenplus (6 commits)")

---

Tags

apilaraveldocumentation

###  Code Quality

TestsPest

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/metafox-scribe/health.svg)

```
[![Health](https://phpackages.com/badges/metafox-scribe/health.svg)](https://phpackages.com/packages/metafox-scribe)
```

###  Alternatives

[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k12.2M45](/packages/knuckleswtf-scribe)[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[mpociot/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

3.5k3.1M12](/packages/mpociot-laravel-apidoc-generator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
