by M165437

API Blueprint Renderer for Laravel, customizable via Blade templates

208 Stars 26 Forks Last release: 7 months ago (v1.0.0) MIT License 45 Commits 18 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Blueprint Docs

Latest Stable Version Total Downloads Latest Unstable Version License Twitter

API Blueprint Renderer for Laravel

This Laravel package Blueprint Docs renders your API Blueprint. It comes with a standard theme that you can customize via Blade templates. Install the package and find your rendered documentation at route


Example output: If used with API Blueprint boilerplate, this would be Blueprint Docs' output.

API Blueprint is a Markdown-based document format that lets you write API descriptions and documentation in a simple and straightforward way. Currently supported is API Blueprint format 1A.


  • Laravel 5.4 or greater
  • Drafter (the official C++ API Blueprint parser) command line tool
  • A valid API Blueprint
    in the root directory of your Laravel project (example available)

Drafter is not included and must be installed beforehand. Use the Drafter Installer composer package to "install drafter in your php project with ease". Head over there and install it now.


Install the package via composer:

composer require m165437/laravel-blueprint-docs

Next, register its service provider (Laravel >= 5.5 does this automatically via Package Discovery):

// config/app.php
'providers' => [

Optionally, publish the example API Blueprint boilerplate file

to the root directory of your Laravel project:
php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="example"

Finally, publish its assets to

php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="public"

Find your documentation at route



When you update this package, you might need to republish its assets (note the added parameter

php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="public" --force


To adjust Blueprint Docs' configuration, publish its config file to

php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="config"

The default contents of the configuration file look like this:

return [

| Blueprint Docs
| Find your rendered docs at the given route or set route to false if you
| want to use your own route and controller. Provide a fully qualified
| path to your API blueprint as well as to the required Drafter CLI.

'route' => 'api-documentation',

'condense_navigation' => false,

'blueprint_file' => base_path('blueprint.apib'),

'drafter' => base_path('vendor/bin/drafter')


If you want to use Blueprint Docs with your own route and controller, set

'route' => false
and have a look at
to get an idea on how to set it up.


To customize the default theme, publish its views to

php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="views"


Thank you for considering contributing to this package! Please see CONTRIBUTING for details.


This package relies heavily on work done by Hendrik Maus, namely his Drafter PHP Wrapper and Reynaldo, it's inspired by Aglio, an API Blueprint renderer written in Node.js, and provides the API Blueprint boilerplate as an example. The header is the modified part of a graphic created by Iconicbestiary, via


Blueprint Docs is licensed under the MIT License (MIT). Please see the LICENSE file for more information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.