jackz/apifox-openapi-importer

A PHP library for importing OpenAPI specifications to Apifox

dev-main 2026-03-04 05:39 UTC

Requires

• php: >=7.4
• ext-curl: *

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Jackz

README

一个用于将 OpenAPI 规范导入到 Apifox 的 PHP 库。

安装

composer require jackz/apifox-openapi-importer

使用方法

基本用法

use Apifox\OpenApiImporter\ApifoxClient;

$client = new ApifoxClient($accessToken, $projectId);

// 从 URL 导入
$response = $client->importOpenApiFromUrl('https://petstore.swagger.io/v2/swagger.json');

// 从内容导入
$response = $client->importOpenApiFromContent($openApiContent);

高级选项

$options = [
    'targetEndpointFolderId' => 76,
    'targetSchemaFolderId' => 60,
    'endpointOverwriteBehavior' => 'deleteUnmatchedResources',
    'schemaOverwriteBehavior' => 'KEEP_EXISTING',
    'updateFolderOfChangedEndpoint' => true,
    'prependBasePath' => true
];

$response = $client->importOpenApiFromUrl($url, $options);

配置选项

• targetEndpointFolderId: 目标接口文件夹 ID
• targetSchemaFolderId: 目标数据模型文件夹 ID
• endpointOverwriteBehavior: 接口覆盖行为
• schemaOverwriteBehavior: 数据模型覆盖行为
• updateFolderOfChangedEndpoint: 是否更新变更接口的文件夹
• prependBasePath: 是否添加基础路径

要求

• PHP >= 7.4
• cURL 扩展

许可证

MIT