API 快速入門

先決條件

基本終端機/命令列技能
caddy 和 curl 在您的 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 body 可能很繁瑣，因此如果您偏好使用檔案，請將 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 教學來學習如何操作！

API 快速入門

延伸閱讀