Swagger-PHP 用于为 Swagger-UI 生成 JSON 文件

我正在尝试使用 Swagger-PHP 生成 JSON 文件，以便我可以将它与 Swagger-UI 一起使用来自动记录文档。

我尝试了链接：-https://github.com/zircote/swagger-php https://github.com/zircote/swagger-php

我还尝试解决那里的文档http://zircote.com/swagger-php/installation.html http://zircote.com/swagger-php/installation.html

但我运气不好，无法实施。

我能够正确安装作曲家。 Swagger-PHP 包也已正确安装。

但问题是我无法使用/理解他们提供的测试示例。

所以如果有人解决过这个问题请帮忙！！

提前致谢 ！！

您只需在代码、模型示例中添加注释（也称为注释）即可：

/**
* @SWG\Model(
* id="vps",
* required="['type', 'hostname']",
*  @SWG\Property(name="hostname", type="string"),
*  @SWG\Property(name="label", type="string"),
*  @SWG\Property(name="type", type="string", enum="['vps', 'dedicated']")
* )
*/
class HostVps extends Host implements ResourceInterface
{
    // ...
}

控制器示例：

/**
 * @SWG\Resource(
 *  basePath="http://skyapi.dev",
 *  resourcePath="/vps",
 *  @SWG\Api(
 *   path="/vps",
 *   @SWG\Operation(
 *    method="GET",
 *    type="array",
 *    summary="Fetch vps lists",
 *    nickname="vps/index",
 *    @SWG\Parameter(
 *     name="expand",
 *     description="Models to expand",
 *     paramType="query",
 *     type="string",
 *     defaultValue="vps,os_template"
 *    )
 *   )
 *  )
 * )
 */
 class VpsController extends Controller
 {
     // ...
 }

然后在控制台中：

php swagger.phar ./your-code-source/ -o ./directory-for-output-files

然后在 Swagger UI 中链接生成的文件。 这是帮助吗？

顺便说一句，这个文档：http://zircote.com/swagger-php/annotations.html http://zircote.com/swagger-php/annotations.html是不完整的。最好依赖解析器错误，例如：

php swagger.phar ./skynode-api/api/ -o ./foo
Swagger-PHP 0.9.0
-----------------
[INFO] Skipping unsupported property: "foo" for @Swagger\Annotations\Property, expecting "name", "description", "type", "format", "items", "uniqueItems", "required", "minimum", "maximum", "enum", "defaultValue", "_partialId", "_partials" in HostVps in /home/kane/some-dir/some-file.php on line 3

EDIT：Swagger 2.0有相当好的规格在 GitHub 上 https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md

顺便说一句，考虑使用招摇编辑器 http://editor.swagger.io/创建要在 Swagger UI 中使用的 api 规范文件 (json/yaml)。因为 php 文件中的内联 SWG 文档非常丑陋，而且 IDE 中没有自动完成支持。