文档
一个 项目

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 教程了解更多!

延伸阅读