v2中文文档
项目

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”端点(localhost:2016),或用curl确认其可用:

curl localhost:2016
Goodbye, world!

使用完Caddy后,记得停止它:

caddy stop

API还能做更多事,包括导出配置、以及对配置做细粒度变更(而不是整份替换)。请继续阅读完整API教程

进一步阅读