PHP code example of clcbws / laravel-api-blueprint
1. Go to this page and download the library: Download clcbws/laravel-api-blueprint library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
clcbws / laravel-api-blueprint example snippets
return [
/*
|--------------------------------------------------------------------------
| Global Enable/Disable Toggle
|--------------------------------------------------------------------------
| Set to false to disable documentation endpoints and commands completely.
*/
'enabled' => env('API_BLUEPRINT_ENABLED', true),
/*
|--------------------------------------------------------------------------
| Routing Dashboard Path
|--------------------------------------------------------------------------
| The base URI where your documentation will be served (e.g., http://your-app.test/api-blueprint).
*/
'path' => env('API_BLUEPRINT_PATH', 'api-blueprint'),
/*
|--------------------------------------------------------------------------
| Route Middleware Stack
|--------------------------------------------------------------------------
| Middleware applied to the docs viewer and schema routes. Custom middleware
| or authentication guards can be added here.
*/
'middleware' => [
LaravelApiBlueprint\Http\Middleware\GatedDocAccess::class,
],
/*
|--------------------------------------------------------------------------
| Gated Access Security Control
|--------------------------------------------------------------------------
| You can secure your endpoints using standard HTTP basic auth credentials,
| or define a custom Laravel authorization Gate (e.g., 'view-api-docs')
| for session and role-based checks.
*/
'auth' => [
'username' => env('API_BLUEPRINT_USERNAME', 'admin'),
'password' => env('API_BLUEPRINT_PASSWORD', 'secret'),
// Example: Gate::allows('view-api-docs')
'gate' => null,
],
/*
|--------------------------------------------------------------------------
| Route Inspection Filters
|--------------------------------------------------------------------------
| Define the prefix scopes. Only routes matching these prefix filters will
| be parsed and compiled by the documentation engine.
*/
'route_prefixes' => ['api/'],
/*
|--------------------------------------------------------------------------
| High-Performance Spec Caching
|--------------------------------------------------------------------------
| Set to true to cache the compiled specification file on disk, avoiding
| parsing controller files on every web view.
*/
'cache_enabled' => env('API_BLUEPRINT_CACHE', true),
/*
|--------------------------------------------------------------------------
| Structural Exporter Target Outputs
|--------------------------------------------------------------------------
| Path locations where Postman collection and programming language schemas
| will be compiled and dumped when running the export command.
*/
'outputs' => [
'postman_path' => storage_path('app/api-blueprint/postman_collection.json'),
'typescript_path' => storage_path('app/api-blueprint/api.d.ts'),
'swift_path' => storage_path('app/api-blueprint/api.swift'),
'java_path' => storage_path('app/api-blueprint/dto'),
'dart_path' => storage_path('app/api-blueprint/api.dart'),
'go_path' => storage_path('app/api-blueprint/api.go'),
],
/*
|--------------------------------------------------------------------------
| Route Grouping / Tagging Mappings
|--------------------------------------------------------------------------
| Define custom tags/groups for specific URI patterns or controller names.
| Matches can use wildcards (e.g. 'api/v1/auth/*' or 'App\Http\Controllers\Admin\*').
*/
'groups' => [
// 'api/v1/auth/*' => 'Authentication',
],
/*
|--------------------------------------------------------------------------
| API Documentation Overview
|--------------------------------------------------------------------------
| Path to a Markdown file containing the custom overview/guide documentation.
| If not specified or if the file does not exist, a default elegant guide is shown.
*/
'overview_path' => resource_path('api-blueprint/overview.md'),
/*
|--------------------------------------------------------------------------
| API Version
|--------------------------------------------------------------------------
| The current version of your API endpoints.
| This is mapped to the OpenAPI and Postman schemas automatically.
*/
'version' => env('API_BLUEPRINT_VERSION', '1.0.0'),
];