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

Question

像 Laravel 或 Cake PHP 这样的框架已经支持，但我有我的旧核心 PHP 项目，我需要为其现有的 API 实现 Swagger。请建议我，因为它的文档非常难以面对。

标签： phpapiswaggerswagger-codegenswagger-php

Answer 1

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

它是一个 yaml 或 json 文件规范，用于记录您的 rest api。

您需要知道您的 api 是如何工作的，这不是一个自动过程。

我建议先手动编写 yaml 文件来描述一个 api 端点，并通过 swagger-ui 查看文件。

一旦您对规范有点熟悉，您就可以考虑 swagger-php，它也与框架无关。好处是文档更接近实现，这使得它更有可能在代码更改时得到更新。