Laravel Swagger 生成 API 文档
Laravel Swagger 生成 API 文档
1. 安装 l5-swagger
包
https://github.com/DarkaOnLine/L5-Swagger
2. PHPStorm 安装 php annotations
插件
增加一条别名数据, 下图红线画出来的. 这样就可以有 swagger 的注释提示了.
3. 如何编写 注释
进而生成 文档
3.1 学习资源
- swagger-php guide
- swagger-php 里面有例子,但是我发现好像不是很全
- Swagger Editor
- swagger 文档
加油好好看!
4. 当前遇到的问题
@AO\Header
在swagger ui
中不显示(我用的是 openApi 3.0).
5. 总结
就目前我的体验, 个人感觉这个东西上手稍微有点难, 而且在每个方法前面写 Swagger 的注释很麻烦, 编写文档注释比开发的时间还要长.倒不如直接编写 swagger 读取的 json/ymal 文件.
本作品采用《CC 协议》,转载必须注明作者和本文链接
推荐文章: