leandrodiogenes/scribe

Generate API documentation for humans from your Laravel codebase.✍

1.1.13 2022-01-11 14:52 UTC

Requires

• php: >=7.2.5
• ext-json: *
• erusev/parsedown: ^1.7.4
• fzaninotto/faker: ^1.9.1
• illuminate/console: ^5.8|^6.0|^7.0
• illuminate/routing: ^5.8|^6.0|^7.0
• illuminate/support: ^5.8|^6.0|^7.0
• knuckleswtf/pastel: ^1.3.3
• league/flysystem: ^1.0
• mpociot/reflection-docblock: ^1.0.1
• nunomaduro/collision: ^3.0|^4.0|^5.0
• ramsey/uuid: ^3.8|^4.0
• shalvah/clara: ^2.6
• symfony/var-exporter: ^4.0|^5.0

Requires (Dev)

• brianium/paratest: ^4.0
• dms/phpunit-arraysubset-asserts: ^0.1.0
• laravel/lumen-framework: ^5.7|^6.0|^7.0
• league/fractal: ^0.19.0
• orchestra/testbench: ^3.7|^4.0|^5.0
• phpstan/phpstan: ^0.12.19
• phpunit/phpunit: ^8.0|^9.0

Suggests

• league/fractal: Required for transformers support

Replaces

• mpociot/laravel-apidoc-generator: *

MIT

• Shalvah

• documentation
• api
• laravel
• dingo

README

v3 is out now!

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.

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.