FSharpCompiler.Json 1.2.0

FSharpCompiler.Json

FSharpCompiler.Json is a easy to use and configurable JSON framework for F#.

• Flexible JSON serializer for converting between F# type and JSON.

• DU Json type for manually reading and writing JSON.

• The Urljson format is used for tree structure data for URL queries. It's shorter than the Json format.

Features

JsonFormatter

The function JsonFormatter.serialize serializes an instance of a type into a JSON string.

JsonFormatter.serialize:'t -> string

For example:

let r = {| x = 0; y = false; |}
let y = JsonFormatter.serialize r
should.equal y """{"x":0,"y":false}"""

The function JsonFormatter.deserialize converts the JSON string into an instance of a given type.

JsonFormatter.deserialize: string -> 't

For example:

let json = """{"x":0,"y":false}"""
let y = JsonFormatter.deserialize<{|x:int;y:bool|}> json
let obj = {| x = 0; y = false; |}
should.equal y obj

The function JsonFormatter.serializeDynamic is Dynamic serialization, which converts reflected type and instance data into a JSON string.

JsonFormatter.serializeDynamic: Type -> obj -> string

For example:

let obj = {| x = 0; y = false; |}
let y = JsonFormatter.serializeDynamic typeof<{|x:int;y:bool|}> obj
should.equal y """{"x":0,"y":false}"""

The function JsonFormatter.deserializeDynamic is Dynamic deserialization that converts the given JSON string into instances of a given type.

JsonFormatter.deserializeDynamic: Type -> string -> obj

For example:

let json = """{"x":0,"y":false}"""
let y = JsonFormatter.deserializeDynamic typeof<{|x:int;y:bool|}> json
let obj = box {| x = 0; y = false; |}
should.equal y obj

UrlQuery

The module UrlQuery represents the Query part of an url.

The function UrlQuery.parseField resolves the field value of a single key value pair in the query string as an instance of an F# type.

UrlQuery.parseField: string -> 't

For example:

let x = "[`xyz`,`123`]"
let y = UrlQuery.parseField<string[]> x
let z = [|"xyz";"123"|]
should.equal y z

The function UrlQuery.parse resolves the entire query string to an instance of F# type.

UrlQuery.parse: seq<string*string> -> 't 

For example:

let pairs = ["foo","bar";"abc","[`xyz`,`123`]"]
let y = UrlQuery.parse<{|foo:string;abc:string[]|}> pairs
let z = {|abc=[|"xyz";"123"|];foo="bar"|}
should.equal y z

This function UrlQuery.parseFieldDynamic dynamically resolves a single field value of a query string for an instance of a given type.

UrlQuery.parseFieldDynamic: Type -> string -> obj

For example:

let urljson = "[`xyz`,`123`]"
let y = UrlQuery.parseFieldDynamic typeof<string[]> urljson
let z = box [|"xyz";"123"|]
should.equal y z

The function UrlQuery.parseQueryDynamic dynamically resolves a single field value of a query as an object instance of the given F# type.

UrlQuery.parseQueryDynamic: Type -> seq<string*string> -> obj

For example:

let pairs = ["foo","bar";"abc","[`xyz`,`123`]"]
let y = UrlQuery.parseQueryDynamic typeof<{|foo:string;abc:string[]|}> pairs
let z = box {|abc=[|"xyz";"123"|];foo="bar"|}
should.equal y z

JsonTree

The JsonTree module is the module that operates Json DU type.

This function reads the instance of the F# type as an instance of DU Json type.

JsonTree.read: 't -> Json

For example:

let x = {|foo="bar";abc = ["xyz";"123"]|}
let y = JsonTree.read<{|foo:string;abc:string list|}> x
should.equal y
<| Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]

This function JsonTree.write converts the instance of DU Json type to an instance of the F# type.

JsonTree.write: Json -> 't

For example:

let json = Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]
let y = JsonTree.write<{|foo:string;abc:string list|}> json
let z = {|foo="bar";abc = ["xyz";"123"]|}
should.equal y z

The function JsonTree.stringifyJson serializes the instance of DU Json type into a JSON string.

JsonTree.stringifyJson: Json -> string

For example:

let json = Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]
let y = JsonTree.stringifyJson json
let z = """{"abc":["xyz","123"],"foo":"bar"}"""
should.equal y z

The function JsonTree.parseJson parses the Json string to an instance of DU Json type.

JsonTree.parseJson: string -> Json

For example:

let x = """{"abc":["xyz","123"],"foo":"bar"}"""
let y = JsonTree.parseJson x
let json = Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]
should.equal y json

The function JsonTree.stringifyUrljson serializes the instance of DU Json type into an Urljson string.

JsonTree.stringifyUrljson: Json -> string

For example:

let json = Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]
let y = JsonTree.stringifyUrljson json
let z = "{abc:[`xyz`,`123`],foo:`bar`}"
should.equal y z

The function JsonTree.parseUrljson parses the Urljson string to an instance of DU Json type.

JsonTree.parseUrljson: string -> Json

For example:

let x = "{abc:[`xyz`,`123`],foo:`bar`}"
let y = JsonTree.parseUrljson x
let json = Json.Object ["abc",Json.Array [Json.String "xyz";Json.String "123"];"foo",Json.String "bar"]
should.equal y json

ASP.NET

FSharpCompiler.Json can be integrated into the ASP.NET as JSON's serialization library, Please use the library: AspNetCore.FSharpCompilerJson。

see also

• The walkthrough tutorial is an ASP.NET solution that demonstrates how clients and servers serialize data.