如何在我的Core PHP项目中为现有API集成Swagger?

时间:2019-08-20 05:17:14

标签: php api swagger swagger-codegen swagger-php

Laravel或Cake PHP之类的框架已经支持了,但是我有一个旧的核心PHP项目,需要在其中为现有的API实现Swagger。请建议我,因为它的文档非常困难且难以处理。

1 个答案:

答案 0 :(得分:0)

Swagger / OpenApi不需要框架的支持。

这是记录您的其余api的yaml或json文件规范。

您需要知道api的工作原理,这不是一个自动过程。

我建议先手动编写yaml文件以描述api端点,然后通过swagger-ui查看该文件。

一旦您对规范有所了解,可以考虑使用swagger-php,它也是与框架无关的。好处是文档离实现更近了,这使得代码更改时更有可能被更新。