README

Caddy v2 API 辅助库，用于PHP。

Caddy v2 允许您通过JSON API更新您的Caddy配置。此包是一个简单的辅助库，用于更新配置的一部分。

将逐步添加更新配置所有方面的功能。

用法

要开始，创建一个OhSeeSoftware\CaddyConfig\Client实例，确保传递Caddy网络地址作为第一个参数

$client = new OhSeeSoftware\CaddyConfig\Client('localhost:2019');

从那里，您可以使用$client实例向您的Caddy实例发送API请求。

包装器背后的想法是您可以有一个Client单例类，然后使用$client->request()方法创建新的Request实例。您应该为发送到Caddy服务器的每个HTTP请求创建一个新的Request实例。

API方法

Client

__constructor()

创建Client类的新实例。

参数

• $caddyHost - 字符串：Caddy配置端点监听的地址。

setCaddyHost()

允许您在创建Client实例后更改Caddy主机。

参数

• $caddyHost - 字符串：Caddy配置端点监听的地址。

request()

返回一个新Request实例，您可以使用它来发送配置请求。

无参数。

Request

使用Request类来构建您要发送到Caddy的请求。以下是如何向服务器添加新主机的示例

$client = new OhSeeSoftware\CaddyConfig\Client('localhost:2019');
$client->request()
  ->http()
  ->server('srv0')
  ->route(0)
  ->match(0)
  ->addHost('example.com');

__constructor()

创建Request类的新实例。

参数

• $caddyHost - 字符串：Caddy配置端点监听的地址。

addHost()

向Caddy发送请求以添加指定的主机。

参数

• $host - 字符串：要添加的主机。

返回

• Response - 包装在Response实例中的Caddy响应。

http()

将http路径“/apps/http”添加到请求URI。

无参数。

返回

• Request - 请求实例（允许链式操作）。

server()

将服务器路径“/servers/{server）”添加到请求URI。

参数

• $server - 字符串：要针对的服务器名称。

返回

• Request - 请求实例（允许链式操作）。

route()

将路由路径“/routes/{routeIndex）”添加到请求URI。

参数

• $routeIndex - 整数：要针对的路由。

返回

• Request - 请求实例（允许链式操作）。

match()

将匹配路径“/match/{matchIndex）”添加到请求URI。

参数

• $matchIndex - 整数：要匹配的对象。

返回

• Request - 请求实例（允许链式操作）。

sendRequest()

将构建的请求发送到Caddy服务器。

参数

• $method - 字符串：请求的方法。
• $body - 数组|可空：要发送到Caddy的请求正文。

返回

• Response - 新的Response实例。

Response

__constructor()

创建Response类的新实例。

参数

• $response - ResponseInterface：Guzzle创建的ResponseInterface实例。

getBody()

返回响应正文作为字符串。

无参数。

isSuccessful()

返回一个布尔值，指示请求是否成功。状态码为200或201被视为成功，其他情况均不视为成功。

无参数。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。