java - 集成java + php swagger

Question

我在我的java（spring mvc）中添加了一个文件配置，我想添加我的php /的ui端点，我认为这样做的一个好方法是在php-> create json中创建yaml并然后将这些文件导入Java。资源。然后如何在java的摘要中使用它。在摘要中，我的配置是将包括外部路径中包含的每个控制器，但现在我想将所有控制器与外部并调用php（通过使用其json文件）以及总的diffrenet路径
任何想法？

Answer 1

如何将Swagger-UI添加到PHP服务器代码：

首先，所有Swagger用户界面都需要一个.json文件，该文件位于以OpenAPI编写的API规范中。该.json文件的路径是在Swagger-UI的index.html中配置的。 index.html文件要求从NPM中获取Swagger软件包代码，以便进行渲染。浏览器将一起呈现代码，从而创建SwaggerUI！

安装（使用Composer）：

composer require zircote/swagger-php

为了从任何地方使用cli，请在全局安装swagger-php并确保将〜/ .composer / vendor / bin目录放在PATH中，以便系统可以找到openapi可执行文件。

composer global require zircote/swagger-php

用法：

向您的php文件添加注释。

/**
 * @OA\Info(title="My First API", version="0.1")
 */

/**
 * @OA\Get(
 *     path="/api/resource.json",
 *     @OA\Response(response="200", description="An example resource")
 * )
 */

来自php的用法：

生成始终最新的文档。

<?php
require("vendor/autoload.php");
$openapi = \OpenApi\scan('/path/to/project');
header('Content-Type: application/x-yaml');
echo $openapi->toYaml();

从命令行界面使用：

将文档生成为静态json文件。

./vendor/bin/openapi --help

反序列化器的用法：

从json字符串生成OpenApi注释对象，这使以编程方式操作对象变得更加容易。

<?php

use OpenApi\Serializer;

$serializer = new Serializer();
$openapi = $serializer->deserialize($jsonString, 'OpenApi\Annotations\OpenApi');
echo $openapi->toJson();

来自docker的用法：

将swagger文档生成为静态json文件。

docker run -v "$PWD":/app -it tico/swagger-php --help

GitHub： https://github.com/zircote/swagger-php

此处有更多详细信息： https://medium.com/@tatianaensslin/how-to-add-swagger-ui-to-php-server-code-f1610c01dc03