API 快速入門

先備條件

• 基本的終端機 / 命令列技能
• PATH 中的 caddy 和 curl

首次啟動 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

使用 Here 文檔 提供 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 要求。

在 瀏覽器中 或使用 curl 嘗試你的新「goodbye」端點，以確保運作正常

curl localhost:2016
Goodbye, world!

當你使用完 Caddy 時，請務必停止它

caddy stop

你可以使用 API 執行更多操作，包括匯出設定和對設定進行細微變更（與更新整個設定相反）。務必閱讀 完整的 API 教學 以了解如何執行！

進一步閱讀

• 完整的 API 教學
• API 文件