API 快速入门

先决条件

• 基本终端 / 命令行技能
• PATH 中包含 caddy 和 curl

首先启动 Caddy

caddy start

Caddy 当前空闲运行（使用空白配置）。使用 curl 给它一个简单的配置

curl localhost:2019/load \
    -H "Content-Type: application/json" \
    -d @- << EOF
    {
        "apps": {
            "http": {
                "servers": {
                    "hello": {
                        "listen": [":2015"],
                        "routes": [
                            {
                                "handle": [{
                                    "handler": "static_response",
                                    "body": "Hello, world!"
                                }]
                            }
                        ]
                    }
                }
            }
        }
    }
EOF

使用 Heredoc 提供 POST 正文可能很繁琐，因此如果您喜欢使用文件，请将 JSON 保存到名为 caddy.json 的文件中，然后使用此命令代替

curl localhost:2019/load \
  -H "Content-Type: application/json" \
  -d @caddy.json

现在在您的浏览器中加载 localhost:2015 或使用 curl

curl localhost:2015
Hello, world!

我们还可以使用此 JSON 在不同的接口上定义多个站点

{
	"apps": {
		"http": {
			"servers": {
				"hello": {
					"listen": [":2015"],
					"routes": [
						{
							"handle": [{
								"handler": "static_response",
								"body": "Hello, world!"
							}]
						}
					]
				},
				"bye": {
					"listen": [":2016"],
					"routes": [
						{
							"handle": [{
								"handler": "static_response",
								"body": "Goodbye, world!"
							}]
						}
					]
				}
			}
		}
	}
}

更新您的 JSON，然后再次执行 API 请求。

在您的 浏览器 中或使用 curl 尝试新的“goodbye”端点，以确保它工作正常

curl localhost:2016
Goodbye, world!

当您完成 Caddy 操作后，请务必停止它

caddy stop

您可以使用 API 做更多的事情，包括导出配置和对配置进行细粒度的更改（而不是更新整个配置）。请务必阅读完整的 API 教程以了解如何操作！

进一步阅读

• 完整的 API 教程
• API 文档