Swagger-php一个基于PHP开发的自动文档生成器

相信后端开发人员会因为编写开发文档苦苦恼火，这里其实已经有人帮我们处理好了，我们只需要写好注释就行，利用这个swagger包来自动生成文档，非常的方便实用，能够保证我们的文章最新。

其实，将swagger集成到我们的系统中是非常方便的一件事情，不仅方便自己，也方便他人呀。

安装

composer require zircote/swagger-php
	
使用：
1：再需要添加文档的方法上写备注 如

/**
     * @OA\Response(
     *     response=200,
     *     description="successful operation",
     *     @OA\JsonContent(ref="/www/wwwroot/xxxx.com/public"),
     * )
     */
    /**
     * @OA\Get(
     *   path="/index",
     *   summary="文章列表 - 首页",
     *   @OA\Response(
     *     response=200,
     *     description="文章首页列表"
     *   ),
     *   @OA\Response(
     *     response="default",
     *     description="an ""unexpected"" error"
     *   )
     * )
     */
	 
2：扫描输出json

$openapi = \OpenApi\scan('/www/wwwroot/xxxx.com/app/controller');
	header('Content-Type: application/x-yaml');
	echo $openapi->toYaml();
	
3：回到前端配置项目，并填写我们的json地址即可

需要安装

composer require swagger-api/swagger-ui
	
好了，简易教程就到这里，希望这教能能对你有所帮助。

关于详细的使用方法给你个链接

详细示例[2.0版本]不适合此教程，不建议参考
https://learnku.com/laravel/t/7430/how-to-write-api-documents-based-on-swagger-php#747b67

简要示例
https://www.cnblogs.com/shen55/p/10276943.html

推荐大家看简要示例。

注:原创不易,转载请注明出处( https://micuu.com/new/1331.html )，本站所有资源来源于网络收集，如有侵权请联系QQ245557979进行清除。

Swagger-php一个基于PHP开发的自动文档生成器

留言反馈