tripteki/laravelphp-docs

Tript Teknologi 代码库规范

维护者

详细信息

github.com/tripteki/convention-php-docs

主页

源代码

问题

安装: 200

依赖: 0

建议者: 0

安全性: 0

星星: 0

关注者: 0

分支: 0

开放问题: 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-09-28 06:22:44 UTC

README

Tript Teknologi 代码库规范。

入门

安装

$ composer require tripteki/laravelphp-docs

如何使用

  • 将 Tripteki\Docs\Providers\DocsServiceProvider::ignoreConfig() 放入 register 提供者中，然后通过运行（可选）将配置文件发布到您的项目目录中：
php artisan vendor:publish --tag=tripteki-laravelphp-docs-config
  • 在 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"
 * )
 */

用法

php artisan swagger:generate

作者