OasReader 1.6.11.10

There is a newer version of this package available.
See the version list below for details.
dotnet add package OasReader --version 1.6.11.10
NuGet\Install-Package OasReader -Version 1.6.11.10
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="OasReader" Version="1.6.11.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OasReader --version 1.6.11.10
#r "nuget: OasReader, 1.6.11.10"
#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.
// Install OasReader as a Cake Addin
#addin nuget:?package=OasReader&version=1.6.11.10

// Install OasReader as a Cake Tool
#tool nuget:?package=OasReader&version=1.6.11.10

Build NuGet Quality Gate Status codecov

OpenAPI Multi Document Reader for .NET

An OpenAPI reader that merges external references into a single document using the Microsoft OpenAPI toolset

Usage

The class OpenApiMultiFileReader is used to load an OpenAPI specifications document file locally or remotely using a YAML or JSON file. OpenApiMultiFileReader will automatically merge external references if the OAS file uses them. Merging external referenecs that the file is in the same folder as the main OAS file. When loading OAS files remotely, the external references must also be remote files. Currently, you can not load a remote OAS file that has external references to local files.

ReadResult result = await OpenApiMultiFileReader.Read("petstore.yaml");
OpenApiDocument document = result.OpenApiDocument;

In the example above, we have OpenAPI specifications that are split into multiple documents. petstore.yaml contains the paths and petstore.components.yaml contain the components/schemas

petstore.yaml

openapi: 3.0.3
paths:
  /pet:
    post:
      tags:
      - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      requestBody:
        description: Create a new pet in the store
        content:
          application/json:
            schema:
              $ref: 'petstore.components.yaml#/components/schemas/Pet'          
        required: true
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: 'petstore.components.yaml#/components/schemas/Pet'

petstore.components.yaml

openapi: 3.0.3
components:
  schemas:
    Pet:
      required:
      - name
      - photoUrls
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 10
        name:
          type: string
          example: doggie
        category:
          $ref: '#/components/schemas/Category'
        photoUrls:
          type: array
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: photoUrl
        tags:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/Tag'
        status:
          type: string
          description: pet status in the store
          enum:
          - available
          - pending
          - sold
    Category:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: Dogs
      xml:
        name: category
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on OasReader:

Package Downloads
Refitter.SourceGenerator

A C# Source Generator that uses Refitter for generating a REST API Client using the Refit library

Refitter.Core

Core library used by the Refitter CLI tool for generating a C# REST API Client using the Refit library.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on OasReader:

Repository Stars
christianhelle/refitter
Refit Client API Generator for OpenAPI
Version Downloads Last updated
1.6.11.14 350,919 1/7/2024
1.6.11.13 89 1/7/2024
1.6.11.12 2,372 1/6/2024
1.6.11.11 314 1/6/2024
1.6.11.10 91 1/6/2024
1.6.11.9 105 1/6/2024
1.6.11.8 316 1/5/2024
1.6.11.7 242 1/4/2024
1.6.11.6 99 1/4/2024
1.6.11.5 105 1/4/2024
1.6.11.4 93 1/4/2024
1.6.11.3 109 1/3/2024
1.6.11.2 95 1/3/2024
0.1.0.1-preview 89 1/3/2024