gdドキュメント0.8.0

HTMLとJSON APIを公開する

English | 日本語

/ではテンプレートに挨拶を埋め込んだHTML、/api/helloではJSONを返すサービスを作ります。テンプレートとスクリプトは同じディレクトリに置きます。

テンプレートを書く

index.htmlに保存します。

<!doctype html>
<html lang="ja">
<title>Hello</title>
<h1>Hello, {{name}}!</h1>
<p>テンプレートで描画しました。</p>
</html>

{{name}}は、埋め込む位置に合わせて特殊文字を変換(エスケープ)します。たとえばHTML本文では、値に含まれる<がタグとして扱われないようにします。{{{...}}}はこの変換をしないため、外部から受け取った値をそのまま渡さないでください。

ルートを追加する

app.gdに保存します。

var app := GD.web.app()

# Render the greeting and forward rendering failures.
func page(_req: GDWebRequest) -> GDWebResponse, Err:
    return GD.web.view("index.html", {"name": "world"})

# Encode the greeting and forward encoding failures.
func hello(_req: GDWebRequest) -> GDWebResponse, Err:
    return GD.web.json({"message": "Hello, world!"})

func main():
    app.route("GET", "/", page)
    app.route("GET", "/api/hello", hello)
    app.listen(8080, "127.0.0.1")!
    return 0
gd serve app.gd
curl http://127.0.0.1:8080/
curl http://127.0.0.1:8080/api/hello

1つ目のURLをブラウザーで開くと挨拶が表示されます。2つ目はmessageフィールドを持つJSONです。待ち受けアドレスは自分の端末からの接続だけを受け付けます。

エラーを呼び出し元へ返す

GD.web.viewはファイルの読み取りやHTMLの生成で、GD.web.jsonはJSONへの変換で失敗することがあります。結果をそのまま返すと、エラーも呼び出し元へ渡せます。エラー時の応答はGDWebApp.on_errorに登録した関数でまとめて処理できます。

エラーがあるのにreturn reply, nullとすると、成功したことになってしまいます。レスポンスとErrを返す関数では、両方をそのまま返してください。GD.web.htmlは完成済みのHTMLをレスポンスにする関数で、戻り値はレスポンスだけです。

リクエストを読む

リクエストを処理する関数(ハンドラー)はGDWebRequestを受け取ります。JSON本文の値を使う前に、読み取りや解析でエラーが起きていないか確認します。

func echo(req: GDWebRequest) -> GDWebResponse, Err:
    var data, err := req.json()
    if err != null:
        return null, err
    return GD.web.json(data)

app.route("POST", "/api/echo", echo)でPOSTのルートに登録できます。ストリーミング形式の本文は、読み進めた部分を読み直せません。大きなアップロードをメモリにまとめて保存しないよう、readやsaveを使います。

テンプレートを再利用する

繰り返し描画するテンプレートはGD.html.templateでGDHTMLTemplateを作れます。解析済みオブジェクトを保持して、データごとにexecuteを呼びます。解析時と描画時のエラーはそれぞれ確認してください。