4

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

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

我还尝试使用http://zircote.com/swagger-php/installation.html上的文档

但我的运气不好，我无法实现它。

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

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

因此，如果有人解决了它，请帮助！

提前致谢 ！！

4

2 回答 2

11

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

/**
* @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不完整。最好依靠解析器错误，例如：

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

编辑：Swagger 2.0在 GitHub 上有很好的规范

顺便说一句，考虑使用Swagger Editor创建 api 规范文件 (json/yaml) 以在 Swagger UI 中使用。因为 php 文件中的内联 SWG 文档很难看，而且您在 IDE 中没有自动完成支持。

于 2014-01-27T12:04:55.110 回答
0

我最近一直在努力解决这个问题，并看到了一些差异并设法让它发挥作用，并希望可能会缩短其他人：

// In the controller

/**
 * (other swagger stuff like @SWG\Put, etc...)
 *   @SWG\Parameter(name="type",in="path",description="project|task",
 *                  required=true, type="array",             
 *                  @SWG\Items(type="string"), 
 *                  default="project",
 *                  enum={"project", "task"}),
 * (next @SWG\Parameter or closing paran, etc)
 */

我之前曾在模型中使用枚举和@SWG\Items 引用它，但没有保存该代码（我只是在搞乱），我无法取回它。我什至看到我以前赞成这个问题并接受了答案！但以上是我现在可以让它工作的唯一方法，总比没有好。

于 2016-09-01T01:11:06.440 回答