ParameterStyleParsers.OpenAPI 1.0.1-pre-974c1933

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of ParameterStyleParsers.OpenAPI.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package ParameterStyleParsers.OpenAPI --version 1.0.1-pre-974c1933
                    


                    

                
NuGet\Install-Package ParameterStyleParsers.OpenAPI -Version 1.0.1-pre-974c1933
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ParameterStyleParsers.OpenAPI" Version="1.0.1-pre-974c1933" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ParameterStyleParsers.OpenAPI" Version="1.0.1-pre-974c1933" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ParameterStyleParsers.OpenAPI" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ParameterStyleParsers.OpenAPI --version 1.0.1-pre-974c1933
                    


                    

                
#r "nuget: ParameterStyleParsers.OpenAPI, 1.0.1-pre-974c1933"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ParameterStyleParsers.OpenAPI@1.0.1-pre-974c1933
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ParameterStyleParsers.OpenAPI&version=1.0.1-pre-974c1933&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ParameterStyleParsers.OpenAPI&version=1.0.1-pre-974c1933&prerelease
                    


                            Install as a Cake Tool

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.

Continuous Delivery

Installation

dotnet add package ParameterStyleParsers.OpenAPI

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

Getting Started

Create the parser by providing the OpenAPI 3.1 parameter specification.

var parser = OpenAPI.ParameterStyleParsers.ParameterParsers.ParameterValueParser.FromOpenApi31ParameterSpecification(
    JsonNode.Parse("""
    {
        "name": "color",
        "in": "query",
        "schema": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "style": "form",
        "explode": true
    }
    """)!.AsObject());

It's also possible to manually construct the parser.

var parameter = OpenAPI.ParameterStyleParsers.Parameter.Parse(
    name: "color",
    style: "form",
    location: "query",
    explode: true,
    new JsonSchema202012(JsonNode.Parse("""
    {
        "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";
Console.WriteLine(
    parser.TryParse(styleSerializedParameter, out JsonNode? json, out string? error)
        ? json?.ToJsonString()
        : error);
// ["blue","black","brown"]

Serialize json to a parameter style.

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

Schema References

Json pointers represented as URI fragments are supported, other URI's are currently not. It is possible to bring your own Json Schema implementation though.

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

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ParameterStyleParsers.OpenAPI:

Package Downloads
Evaluation.OpenAPI

Evaluates API requests and responses using OpenAPI specifications

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.4.0 107 1/12/2026
1.4.0-pre-a82e71ac 84 1/12/2026
1.4.0-pre-98ae1991 83 1/11/2026
1.4.0-pre-6378fba7 83 1/11/2026
1.4.0-pre-314bd41e 83 1/11/2026
1.3.0 82 1/10/2026
1.3.0-pre-6a5eb765 84 1/10/2026
1.2.1-pre-f6232e95 81 1/10/2026
1.2.1-pre-a083f46c 84 1/10/2026
1.2.1-pre-0596ce88 81 1/10/2026
1.2.0 90 1/10/2026
1.2.0-pre-aa08d0af 84 1/10/2026
1.2.0-pre-63f9807e 82 1/10/2026
1.2.0-pre-452c2def 86 1/10/2026
1.2.0-pre-2203c5c2 84 1/10/2026
1.1.1 307 12/17/2025
1.1.1-pre-90b9f6b9 119 12/13/2025
1.1.1-pre-82653491 144 12/14/2025
1.1.0 205 11/25/2025
1.1.0-pre-de0dd975 525 7/23/2025
1.1.0-pre-c3646a77 193 11/24/2025
1.1.0-pre-be2cd81c 187 11/25/2025
1.1.0-pre-bb7b5b6f 518 7/21/2025
1.1.0-pre-ab0f6177 179 7/16/2025
1.1.0-pre-99058510 523 7/21/2025
1.1.0-pre-73b80428 525 7/24/2025
1.1.0-pre-73303ae8 174 7/17/2025
1.1.0-pre-55d08346 517 7/23/2025
1.1.0-pre-29539c51 182 7/16/2025
1.0.3 268 6/7/2024
1.0.3-pre-5f844d02 160 6/7/2024
1.0.2 163 6/7/2024
1.0.2-pre-59512787 157 6/7/2024
1.0.1 218 6/4/2024
1.0.1-pre-974c1933 145 6/4/2024
1.0.0 2,053 5/29/2024
1.0.0-pre-fc3e8a7a 162 5/29/2024
1.0.0-pre-72c5ba6d 168 5/27/2024
1.0.0-pre-4465deeb 169 5/28/2024
0.1.2-pre-277f96df 163 5/24/2024
0.1.1 173 5/22/2024
0.1.1-pre-02a920e8 162 5/22/2024
0.1.0 232 4/17/2024
0.1.0-pre-62b5499b 189 4/17/2024

## [v1.0.1-pre-974c1933](https://github.com/Fresa/OpenAPI.ParameterStyleParsers/compare/e2cf3a6699f7b694ed37b14a121e9fe55dcac7f6...974c19336ab22b483a4499b0a07b6557a3f74024) (2024-06-04)


### Bug Fixes

* **form:** primitive form style must include the parameter name ([974c193](https://github.com/Fresa/OpenAPI.ParameterStyleParsers/commit/974c19336ab22b483a4499b0a07b6557a3f74024))