PHP 配置 | Fern Documentation

您可以在 generators.yml 中自定义 PHP SDK 生成器的行为：

generators.yml

1 groups:
2   php-sdk:
3     generators:
4       - name: fernapi/fern-php
5         version: 2.8.1
6         config:
7           clientName: YourClientName

SDK 配置选项

clientName

string

设置生成的 API 客户端类的名称。这决定了用户在生成的 PHP SDK 中与之交互的主要客户端类型名称。

composerJson

Record<string, any>

允许自定义生成的 composer.json 文件内容。您可以指定额外的元数据、依赖项或配置，这些将合并到包的 composer 配置文件中。

enable-wire-tests

booleanDefaults to false

启用时，生成模拟服务器（wire）测试来验证 SDK 是否按预期发送和接收 HTTP 请求。

inlinePathParameters

boolean

启用时，路径参数作为请求类中的属性包含，而不是作为单独的方法参数传递。这创建了一个更统一的请求结构，其中所有参数都在请求对象中分组。

namespace

string

指定所有生成代码的 PHP 命名空间。这决定了用户在导入和使用 SDK 类时将使用的命名空间层次结构。

packageName

string

设置 PHP 包的名称，该名称将出现在 Composer 和 Packagist 中。这是用户通过 Composer 安装 SDK 时将使用的名称（例如，composer require your/package-name）。

packagePath

string

指定生成的 SDK 源文件应放置的目录路径。这决定了生成的 PHP 代码相对于输出目录的文件系统位置。

propertyAccess

'public' | 'private'

控制生成的类属性的访问级别。设置为 ‘public’ 时，属性是公共的且省略 getter/setter 方法。设置为 ‘private’ 时，属性是私有的且为封装生成 getter/setter 方法。