JSONとHTTPの例¶
OnionはJSON/YAMLの解析、HTTPリクエスト、recordからのシリアライザ導出を内蔵でサポートしています。
recordからJSONを導出¶
recordに derive!(Json) を付けると、toJson と fromJson 静的メソッドが自動生成されます。
record User(id: Int, name: String, email: String) derive!(Json)
val user = new User(1, "Alice", "alice@example.com")
val json = User::toJson(user)
println(json)
val parsed: User? = User::fromJson(json)
if parsed != null {
println("name=" + parsed.name())
}
出力:
JSON文字列の解析¶
アドホックなJSONには Json モジュールを直接使います。
val raw = "{\"count\": 42, \"items\": [\"a\", \"b\", \"c\"]}"
val map = Json::parse(raw) as Map
println("count=" + map.get("count"))
YAML設定ファイル¶
recordに derive!(Yaml) を付けるとYAMLも扱えます。
record ServerConfig(host: String, port: Int, debug: Boolean) derive!(Yaml)
val yaml = "host: localhost\nport: 8080\ndebug: false\n"
val cfg: ServerConfig? = ServerConfig::fromYaml(yaml)
if cfg != null {
println(cfg.host() + ":" + cfg.port())
}
HTTP GETリクエスト¶
Http モジュールで簡単なHTTP呼び出しができます。
try {
val response = Http::get("https://api.example.com/users")
println("length=" + response.length())
} catch e: Exception {
println("request failed: " + e.getMessage())
}
JSONを含むHTTP POST¶
JSONを含むPOSTリクエストを送信します。
val payload = "{\"name\":\"Alice\",\"age\":30}"
try {
val response = Http::postJson("https://api.example.com/users", payload)
println(response)
} catch e: Exception {
println("request failed")
}
完全な例: JSON APIクライアント¶
JsonApiClient.on はrecordのシリアライズ、HTTP GET、ネットワークが利用できない場合のフォールバックを示します。
record User(id: Int, name: String, email: String) derive!(Json)
val userJson = "{\"id\":1,\"name\":\"Alice\",\"email\":\"alice@example.com\"}"
val user = User::fromJson(userJson)
if user != null {
println("parsed " + user.name())
}
val url = "https://httpbin.org/get"
try {
val response = Http::get(url)
println("http status length=" + response.length())
} catch e: Exception {
println("network request skipped")
}
// ラウンドトリップ
val bob = new User(42, "Bob", "bob@example.com")
val back = User::fromJson(User::toJson(bob))
if back != null {
println("roundtrip=" + back.name())
}
URLユーティリティ¶
クエリ文字列の構築や値のエンコードができます。
val query = Http::buildQuery(["q", "onion lang", "limit", "10"])
val url = "https://api.example.com/search?" + query
println(url)
次のステップ¶
- スクリプティングの例 - CLI引数とプロセス実行
- 非同期の例 - HTTP呼び出しを並列で行う
- 標準ライブラリリファレンス - Http/Json/Yaml API全文