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

ヒアドキュメントで 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 チュートリアルを読んで、方法を学んでください!

API クイックスタート

その他のリーディング