# knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

Repository: https://github.com/knuckleswtf/scribe
Canonical: https://ross.abutalabs.com/products/knuckleswtf-scribe
Homepage: https://scribe.knuckles.wtf/laravel/
Language: PHP
License: MIT
License Family: permissive
Last push: 2026-08-13T22:38:14+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 97, release rhythm 87, longevity 100
- inputs: {"age_days": 2314, "days_push": 20, "days_rel": 86, "gap_med": 28.5, "n_releases_24m": 17}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2329, forks 356 (observed 2026-08-28T04:06:37.612216+00:00)

## What it is
Scribe is a PHP/Laravel package that automatically generates human-friendly API documentation from a Laravel codebase. It produces a single-page HTML doc with an in-browser API tester, plus Postman collections and OpenAPI specs.

## Use cases
- generate api documentation from laravel codebase
- create openapi spec for my laravel api
- generate postman collection from laravel routes
- document formrequest validation rules automatically
- add try-it-out api tester to docs
- auto-generate sample api responses from eloquent resources

## When to choose
- you have a Laravel (or Lumen) API and want docs generated from your code
- you want OpenAPI specs and Postman collections alongside HTML docs
- you want sample responses extracted from FormRequests, API Resources, or Transformers

## When to avoid
- your API is not built with Laravel/Lumen
- you need framework-agnostic documentation generation
- you want hand-written docs rather than code-derived ones

## Facets
- artifact type: library
- maturity: active
- function: api-documentation, documentation, sdk
- domain: web-development, backend, documentation, apis
- platform: php, cli
- tags: laravel, openapi, postman-collection, api-docs-generator

## Member repositories
- knuckleswtf/scribe (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:37.612216+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:38:11.180660+00:00, confidence not recorded.
  - readme: https://github.com/knuckleswtf/scribe (fetched 2026-08-28T04:06:37.612216+00:00, sha 9cca4eac3147)
  - homepage: https://scribe.knuckles.wtf/laravel/ (fetched 2026-08-29T10:18:29.832706+00:00, sha 5073ff819530)
  - site_page: https://scribe.knuckles.wtf/laravel/getting-started (fetched 2026-08-29T10:18:29.835149+00:00, sha b38425f2c3e1)
- Data as of 2026-08-30T08:39:29.467469+00:00.