文档
a project

API 快速入门

先决条件:

  • 基本的终端/命令行技能
  • caddycurl 在 PATH 中

首先启动Caddy:

caddy start

Caddy 当前处于空闲状态(具有空白配置)。使用 curl 给它一个简单的配置:

curl localhost:2019/load \
    -X POST \
    -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 \
  -X POST \
  -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教程,以了解如何使用!

进一步阅读