ParameterStyleParsers.OpenAPI 1.0.0-pre-72c5ba6d

OpenAPI.ParameterStyleParsers

Parameter style parsers for OpenAPI 3.1.

The examples in the OpenAPI specification doesn't match RFC6570 fully, in those cases the examples in the specification are followed.

Installation

dotnet add package ParameterStyleParsers.OpenAPI

https://www.nuget.org/packages/ParameterStyleParsers.OpenAPI/

Getting Started

Parse the OpenAPI 3.1 parameter from the specification, and create a parameter value parser.

/* Parameter specification example:
{
    "name": "color",
    "in": "query",
    "schema": {
        "type": "array",
        "items": {
            "type": "string"
        }
    },
    "style": "form",
    "explode": true
}
*/

var parameter = OpenAPI.ParameterStyleParsers.Parameter.Parse(
    name: "color",
    style: "form",
    location: "query",
    explode: true,
    JsonSchema.FromText("""
    {
        "type": "array",
        "items": {
            "type": "string"
    }
    """)
);
var parser = OpenAPI.ParameterStyleParsers.ParameterParsers.ParameterValueParser.Create(parameter);

Parse a style serialized parameter

string styleSerializedParameter = "color=blue&color=black&color=brown";
parser.TryParse(styleSerializedParameter, out JsonNode? parameter, out string? error);
Console.WriteLine(parameter.ToJsonString());
// ["blue","black","brown"]

Serialize json to a parameter style.

var json = JsonNode.Parse("""
    ["blue","black","brown"]
""");
string styleSerializedParameter = parser.Serialize(json);
Console.WriteLine(styleSerializedParameter);
// color=blue&color=black&color=brown

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT