文档
一个 项目

API 快速入门

先决条件:

  • 基本的终端 / 命令行 操作技能
  • caddycurl 位于你的 PATH 中

首先启动 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 请求。

在浏览器中访问你新的 “goodbye” 端点 在这里 或使用 curl 以确保其正常工作:

curl localhost:2016
Goodbye, world!

完成使用 Caddy 后,请务必停止它:

caddy stop

API 能做的还有很多,例如导出配置和对配置进行细粒度的更改(而不是替换整个配置)。一定要阅读完整的 API 教程以深入了解!

进一步阅读