大家都用什么方式实现接口文档生成

问答 / 2 / 21 / 创建于 1年前

请问大家在使用 Laravel 框架时都用什么方式实现接口文档生成？现在都用 swagger 吗？还是有其他选项？

sanders

课程读者 644 声望

程序员鼓励师 @ KDD

暂无个人描述~

0 人点赞

从零开发一个电商项目，功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等

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

silie

33 声望

最佳答案

用的swagger，然后写了个接口，读取路由，通过注释生成文档，再导入到Apifox里给前端调试，不过有些文档还是手写的，比如websocket，接口的注释大概长这样

    /**
     * 资产管理-设备管理-设备列表
     *
     * @param \App\Http\Requests\Common\Device\IndexRequest $request
     *
     * @return \App\Http\Resources\Common\Device\DeviceResource[]
     */

file

1年前评论

sanders （楼主）

用哪个包？l5-swagger 吗？

silie （作者）

@sanders 用的是zircote/swagger-php，然后写个方法转成OpenApi的格式就可以了

silie （作者）

@sanders 我这种是内部已经定好的一套规则，只能用在新项目上，比如request里的校验规则不能少了string,integer，array等，因为需要这些规则来确定字段类型.
资源层也是封装一下,比如:

return [
            'id' => $this->id,
            'name' => $this->name,
        ];

换成

return [
            'id' => static::int(desc:'设备id'),
            'name' => static::string(desc:'设备名称'),
        ];

讨论数量: 21

lovewei

177 声望

swagger没用过，只用过apifox,showdoc等等，但是从来没有自动生成过接口文档，全部手撸，因为出接口文档也让我排到开发工时里去了

1年前评论

她来听我的演唱会

Laravel 9.x 译者 600 声望

:joy:一直使用showdoc类似的手撸，写文档的同时能自己测一遍，有不对的地方还能排查

1年前评论

忆往昔弹指间

620 声望

都是外部手写的API文档，不喜欢那种侵入到代码生成的

1年前评论

aliongkk

0 声望

apidoc

1年前评论

aliongkk

0 声望

weiwei/api-doc

1年前评论

Imuyu

课程读者 861 声望

Apifox

1年前评论

Danton

1 声望

yapi手撸，缺点是时间一长乱成一锅粥，因为要重构，先用Java套了一层，使用swagger，从头整理了一遍文档

1年前评论

sanders

课程读者 644 声望 / 程序员鼓励师 @ KDD

手撸才是正道？ :stuck_out_tongue_winking_eye:

1年前评论

小煜

19 声望

我目前在用swagger，改接口的同时，接口文档就改了，非常方便

1年前评论

silie

33 声望

    /**
     * 资产管理-设备管理-设备列表
     *
     * @param \App\Http\Requests\Common\Device\IndexRequest $request
     *
     * @return \App\Http\Resources\Common\Device\DeviceResource[]
     */

file

1年前评论

sanders （楼主）

用哪个包？l5-swagger 吗？

silie （作者）

@sanders 用的是zircote/swagger-php，然后写个方法转成OpenApi的格式就可以了

silie （作者）

return [
            'id' => $this->id,
            'name' => $this->name,
        ];

换成

return [
            'id' => static::int(desc:'设备id'),
            'name' => static::string(desc:'设备名称'),
        ];

雷雷

87 声望

全靠手撸，要是懒点就直接发群里

1年前评论

chengjiabing

1 声望

knuckleswtf/scribe

1年前评论

xini2603

54 声望

我都是写到请求控制器层，通过备注生成在线文档与数据库文档

1年前评论

Cooper

347 声望 / Web Developer @ Remote

packagist.org/packages/dedoc/scram...

1年前评论

dryang

课程读者 30 声望

手写，自动生成的感觉效果不太满意

11个月前评论

PHP布道者

110 声望

口口相传

11个月前评论

sanders （楼主）

填空题是吧。

huangcuigang

3 声望

eolink.com，手动写，不喜欢自动生成的接口文档，手动写接口文档的同时也能对接口进行调试

11个月前评论

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

帮助

644 声望

程序员鼓励师 @ KDD

TA 的博客

纠错改进

成为赞助商

大家都用什么方式实现接口文档生成

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

大家都用什么方式实现接口文档生成

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

请登录