tripteki/laravelphp-docs

Trip Teknologi's Codebase Convention

Maintainers

Details

github.com/tripteki/convention-php-docs

Homepage

Source

Issues

Installs: 180

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

1.0.0 2023-11-28 04:38 UTC

Requires

MIT 5c507a8ce7b922255586a510311d12e966bde316

  • Trip Teknologi <tripteki.company.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-28 05:29:02 UTC

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