charescape/scribe

Generate API documentation for humans from your Laravel codebase.✍

dev-next 2025-01-07 07:16 UTC

Requires

• php: >=8.0
• ext-fileinfo: *
• ext-json: *
• ext-pdo: *
• erusev/parsedown: 1.7.4
• fakerphp/faker: ^1.9.1
• illuminate/console: ^8.0|^9.0|^10.0|^11.0
• illuminate/routing: ^8.0|^9.0|^10.0|^11.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0
• league/flysystem: ^1.1.4|^2.1.1|^3.0
• mpociot/reflection-docblock: ^1.0.1
• nikic/php-parser: ^5.0
• nunomaduro/collision: ^5.10|^6.0|^7.0|^8.0
• ramsey/uuid: ^4.2.2
• shalvah/clara: ^3.1.0
• shalvah/upgrader: >=0.6.0
• spatie/data-transfer-object: ^2.6|^3.0
• symfony/var-exporter: ^5.4|^6.0|^7.0
• symfony/yaml: ^5.4|^6.0|^7.0

Requires (Dev)

• brianium/paratest: ^6.0
• dms/phpunit-arraysubset-asserts: ^0.4
• laravel/legacy-factories: ^1.3.0
• laravel/lumen-framework: ^8.0|^9.0|^10.0
• league/fractal: ^0.20
• nikic/fast-route: ^1.3
• orchestra/testbench: ^6.0|^7.0|^8.0
• pestphp/pest: ^1.21
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.0|^10.0
• symfony/css-selector: ^5.4|^6.0
• symfony/dom-crawler: ^5.4|^6.0

Replaces

• mpociot/laravel-apidoc-generator: *

MIT

• Shalvah

• documentation
• api
• laravel
• dingo

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.