tripteki/laravelphp-docs

Trip Teknologi's Codebase Convention

1.0.0 2023-11-28 04:38 UTC

Requires

• php: ^8.0.2
• darkaonline/l5-swagger: ^8.4.1

MIT

• Trip Teknologi

README

Trip Teknologi's Codebase Convention.

Getting Started

Installation :

$ composer require tripteki/laravelphp-docs

How to use :

• Put Tripteki\Docs\Providers\DocsServiceProvider::ignoreConfig() into register provider, then publish config file into your project's directory with running (optionally) :

php artisan vendor:publish --tag=tripteki-laravelphp-docs-config

• Put the comment onto the App\Http\Controllers\Controller :

/**
 * @OA\Info(
 *      title="Application Programming Interface",
 *      version="1.0"
 * ),
 * @OA\SecurityScheme(
 *      securityScheme="bearerAuth",
 *      in="header",
 *      type="http",
 *      scheme="bearer",
 *      bearerFormat="JWT"
 * )
 */

Usage

php artisan swagger:generate

Author

• Trip Teknologi (@tripteki)
• Hasby Maulana (@hsbmaulana)