This page contains a few tips to help you figure out what's wrong when Scribe seems to be malfunctioning.
Update your version
First off, try updating your installed Scribe version. Maybe your problem is due to a bug we've fixed in a newer release. You can see a list of releases and major changes on the changelog.
- To see the exact installed version, run
composer show knuckleswtf/scribe
- To update to the latest version, run
composer update knuckleswtf/scribe.
- To update to a specific version (example: 4.0.1), run
composer update knuckleswtf/scribe:4.0.1.
By default, Scribe will try to keep going until it processes all routes and generates your docs. If it encounters any problems while processing a route (such as a missing
@responseFile or some invalid configuration leading to an exception being thrown), it will output a warning and the exception message, then move on to the next route.
You can turn on debug messages (such as the path Scribe takes in instantiating a model) and full stack traces with the
php artisan scribe:generate --verbose
Make sure you aren't matching
Routes defined in Laravel's web.php typically have the
web middleware, leading to strange behaviour, so make sure you've correctly specified the routes to be matched in your config file. See this GitHub issue.
Turn on debug mode for your app
Sometimes you may see a 500
null response shown in the generated examples. This is usually because an error occurred within your application during a response call. The quickest way to debug this is by setting
true in your
response_calls.config section in your
Alternatively, you can set
APP_DEBUG=true in your
.env.docs file and run
php artisan scribe:generate --env docs.
Clear any cached Laravel config
Sometimes Laravel caches config files, and this may lead to Scribe failing with an error about a null
DocumentationConfig. To fix this, clear the config cache:
php artisan config:clear
Clear cached view templates
Sometimes Laravel caches view templates, and this may lead to your API changes not being reflected in the output. To fix this, clear the view cache:
php artisan view:clear
Clear previously generated docs
Sometimes you may run into conflicts if you switch from one output type to another. While we try to prevent this happening, we don't guarantee it. In such cases, please try clearing the old docs generated from your previous run (
laravel would be in
static would be in
public/docs) and then running again. We recommend copying these out to a different location, just to be safe.
Increase the memory
Generating docs for large APIs can be memory-intensive. If you run into memory limits, try running PHP with an increased memory limit (either by updating your CLI php.ini file or using a CLI flag):
php -d memory_limit=1G artisan scribe:generate
Delete old published templates
After publishing templates, you can delete the ones you don't wish to customise. That way, you easily know which templates you're overriding.
TypeError: hljs.highlightElement / hljs.highlightAll is not a function
This is a frontend error. It usually happens when you're using another tool like Laravel Debug Bar, which loads a conflicting version of highlight.js. To fix, exclude your docs route in your
'except' => [
Some weird behaviour when using FormRequests
FormRequests are not initialized by Scribe in the same way as Laravel would, so you can easily run into issues. See if using the
instantiateFormRequestUsing() hook solves your problem.