Laravel Swagger 生成 API 文档

ouer1994 的个人博客 / 23 / 7 / 创建于 5年前 / 更新于 5年前

Laravel Swagger 生成 API 文档

1. 安装 `l5-swagger` 包

https://github.com/DarkaOnLine/L5-Swagger

2. PHPStorm 安装 `php annotations` 插件

增加一条别名数据, 下图红线画出来的. 这样就可以有 swagger 的注释提示了.
Laravel Swagger 生成 API 文档

3. 如何编写 `注释` 进而生成文档

3.1 学习资源

swagger-php guide
swagger-php 里面有例子,但是我发现好像不是很全
Swagger Editor
swagger 文档

加油好好看!

4. 当前遇到的问题

@AO\Header 在 swagger ui 中不显示(我用的是 openApi 3.0).

5. 总结

就目前我的体验, 个人感觉这个东西上手稍微有点难, 而且在每个方法前面写 Swagger 的注释很麻烦, 编写文档注释比开发的时间还要长.倒不如直接编写 swagger 读取的 json/ymal 文件.

swagger

本作品采用《CC 协议》，转载必须注明作者和本文链接

课程读者 127 声望

暂无个人描述~

《L04 微信小程序从零到发布》

从小程序个人账户申请开始，带你一步步进行开发一个微信小程序，直到提交微信控制台上线发布。

《L01 基础入门》

我们将带你从零开发一个项目并部署到线上，本课程教授 Web 开发中专业、实用的技能，如 Git 工作流、Laravel Mix 前端工作流等。

推荐文章：

更多推荐...

Laravel 8 开发中使用 swagger-php 3 生成文档 17 / 6 |

用 Laravel 开发的一款文档管理系统 47 / 8 |

Lumen 微服务生成 Swagger 文档 47 / 13 |

如何撰寫立即可交付的組件化 Swagger 文件 20 / 2 |

如何编写基于 Swagger-PHP 的 API 文档 134 / 38 |

API 文档神器 Swagger 介绍及在 PHP 项目中使用 154 / 28 |

讨论数量: 7

pingfan

457 声望

我一般用 apidoc

5年前评论

ouer1994

课程读者 127 声望

@yanthink apidoc 貌似也不错, 已经入了 swagger 的坑就暂时先用这个了 :joy:

5年前评论

tarbozzz

课程读者 0 声望

不是@OA吗？你怎么是@AO

5年前评论

ouer1994

课程读者 127 声望

@zhp_xixi 我擦, 有可能是我写错了. 好久没用 swagger 了, 都忘了. 感觉这个东西太麻烦了. 不喜欢用.

5年前评论

故意

课程读者 1 声望

头部的 accept 怎么设置

5年前评论

ouer1994

课程读者 127 声望

@故意试试这个吧

@OA\Parameter(
   name="Accept",
   required=true,
   in="header",
   description="Accept 请求头",
   @OA\Schema(
      type="string",
      default="application/json"
   )
),

5年前评论

小怪兽

课程读者 17 声望 / 技术主管 @ 广州黑蜂科技有限公司

能否导出离线的pdf文件呢

4年前评论

ouer1994 （楼主）

这个就不清楚了, 早就不用这个了, 应该不可以吧

bennyqqt

@ouer1994 啥原因弃坑？

ouer1994 （楼主）

@bennyqqt 用起来太麻烦了

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助

未填写

私信

文章归档

2 篇 2020 年 1 月 1 篇 2019 年 12 月 2 篇 2019 年 10 月 3 篇 2019 年 9 月 6 篇 2019 年 8 月

5年前初识 webpack (三) 5年前初识 webpack (二) 5年前初识 webpack (一) 5年前 PHP Opcache 5年前 Supervisor

5 Laravel Swagger 生成 API 文档 2 Ubuntu 18.04 需要安装的软件 2 Supervisor 1 CentOS 搭建 GitLab 1 PHP Opcache

博客标签

成为赞助商