Neuro.Content.OpenApi 1.1.1

Neuro.Content.OpenApi

An OpenAPI 3.0.x content codec for the TAG Neuron®. This library provides parsing and serialization of OpenAPI (Swagger) specification documents in JSON format, integrated with the Waher.Content framework.

Overview

Neuro.Content.OpenApi implements both IContentEncoder and IContentDecoder from the Waher.Content framework. It is automatically discovered via Waher.Runtime.Inventory, enabling the TAG Neuron to natively handle OpenAPI documents without additional configuration.

The library provides a complete, strongly-typed object model for OpenAPI 3.0.x specifications along with bidirectional JSON serialization.

Features

• Full OpenAPI 3.0.x document model (paths, operations, schemas, security, components)
• JSON parsing via FromDictionary() factory methods on each model type
• JSON serialization via ToDictionary() on each model type
• Polymorphic schema deserialization (string, integer, number, boolean, array, object, oneOf, allOf, $ref)
• Seamless integration with the Waher.Content codec pipeline

Project

Installation

The library is distributed as a NuGet package:

dotnet add package Neuro.Content.OpenApi

Or via the Package Manager Console:

Install-Package Neuro.Content.OpenApi

Usage

Decoding an OpenAPI document from JSON

using Neuro.Content.OpenApi.Model;
using Waher.Content;

// Parse a JSON string into a dictionary
Dictionary<string, object> dict = (Dictionary<string, object>)JSON.Parse(jsonString);

// Deserialize into the strongly-typed model
OpenApiDocument document = OpenApiDocument.FromDictionary(dict);

// Access API metadata
string title = document.Info?.Title;
string version = document.Info?.Version;

// Iterate paths and operations
foreach (var kvp in document.Paths)
{
    string path = kvp.Key;
    OpenApiPathItem pathItem = kvp.Value;

    if (pathItem.Get != null)
        Console.WriteLine($"GET {path} - {pathItem.Get.Summary}");
}

Encoding an OpenAPI document to JSON

using Neuro.Content.OpenApi.Model;
using Waher.Content;

// Build a document programmatically
OpenApiDocument document = new OpenApiDocument
{
    Info = new OpenApiInfo
    {
        Title = "My API",
        Version = "1.0.0",
        Description = "A sample API"
    }
};

document.Servers.Add(new OpenApiServer { Url = "https://api.example.com" });

// Serialize to a JSON-compatible dictionary
Dictionary<string, object> dict = document.ToDictionary();

// Encode to JSON string
string json = JSON.Encode(dict, false);

Working with schemas

The library supports polymorphic schema types via the abstract OpenApiSchema base class:

using Neuro.Content.OpenApi.Model;

// Access component schemas
if (document.Components != null)
{
    foreach (var kvp in document.Components.Schemas)
    {
        string name = kvp.Key;
        OpenApiSchema schema = kvp.Value;

        if (schema is OpenApiObjectSchema obj)
        {
            foreach (var prop in obj.Properties)
                Console.WriteLine($"  {prop.Key}: {(prop.Value as ITypedSchema)?.Type}");
        }
    }
}

Object Model

Core Types

Schema Types

Other Types

Dependencies

Building

Prerequisites

• .NET SDK supporting .NET Standard 2.1 (e.g., .NET Core 3.0+ or .NET 5+)
• The IoT Gateway repository cloned to C:\My Projects\IoTGateway (for post-build events), or an installed TAG Neuron®

Compile

dotnet build

Package

dotnet pack

The project is configured with <GeneratePackageOnBuild>true</GeneratePackageOnBuild>, so a NuGet package is produced on every build.

Repository

• Source: https://github.com/Trust-Anchor-Group/Neuron.Content.OpenApi
• NuGet: Neuro.Content.OpenApi

License

Copyright © Trust Anchor Group AB. All rights reserved.

This project is licensed under the Trust Anchor Group License. It permits personal evaluation, academic use (with attribution), and security analysis. Commercial use requires a separate license from Trust Anchor Group.