README

基于swagger的Laravel框架API文档。它将提供基于swagger ui最新发布的ui的运行时环境。您可以测试并文档化每个操作和请求对象以及每个可解释的属性。注释非常简单。您可以根据需要管理一切。

注意：- 仅适用于laravel框架。它可以与任何laravel LTS版本相媲美。

如何在laravel上使用此包的说明。

通过composer安装包
composer require julfiker/swagger-laravel
只需运行带有包名称的composer require命令。这假设您已安装composer并且路径中可用为composer。有关如何安装composer的说明 https://getcomposer.org.cn/doc/00-intro.md。

安装后
将服务配置到应用中，请在config/app.php中的providers下添加以下内容
Julfiker\Swagger\SwaggerServiceProvider::class
然后运行以下命令
php artisan vendor:publish
这就完了！！

通过注释的使用说明
将注释添加到您的PHP文件中。您必须在app目录下的任何PHP文件中只使用一次@OA\Info()。我建议将其添加到主页或欢迎页面控制器中，以渲染您的应用程序主页。然后添加API控制器类中的每个控制器操作。

/**
 * Only one time for the application
 * @OA\Info(title="My Laravel REST API", version="1.0") 
 */
 class WelcomeController {
   //Action method and others
 }

/**
 * Action method
 * @OA\Get(
 *     path="/v1/resources",
 *     @OA\Response(response="200", description="About the resources")
 * )
 */
 public function index(){
   //Your code
 }

有关如何使用注释的进一步研究 - http://zircote.com/swagger-php/Getting-started.html#annotation-placement

访问swagger文档
http://{project-url}/swagger/doc

需要帮助吗？
如果您需要这方面的任何帮助，请与我联系，我的联系方式 ~
电子邮件: mail.julfiker@gmail.com
skype: eng.jewel

享受吧！！ 😄

julfiker / swagger-laravel

维护者

详细信息

README

如何在laravel上使用此包的说明。