SimpleW.Helper.Swagger 26.0.0-rc.20260312-1555

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of SimpleW.Helper.Swagger. 
dotnet add package SimpleW.Helper.Swagger --version 26.0.0-rc.20260312-1555
                    


                    

                
NuGet\Install-Package SimpleW.Helper.Swagger -Version 26.0.0-rc.20260312-1555
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="SimpleW.Helper.Swagger" Version="26.0.0-rc.20260312-1555" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SimpleW.Helper.Swagger" Version="26.0.0-rc.20260312-1555" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SimpleW.Helper.Swagger" />
                    


                            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 SimpleW.Helper.Swagger --version 26.0.0-rc.20260312-1555
                    


                    

                
#r "nuget: SimpleW.Helper.Swagger, 26.0.0-rc.20260312-1555"
#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 SimpleW.Helper.Swagger@26.0.0-rc.20260312-1555
#: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=SimpleW.Helper.Swagger&version=26.0.0-rc.20260312-1555&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SimpleW.Helper.Swagger&version=26.0.0-rc.20260312-1555&prerelease
                    


                            Install as a Cake Tool

SimpleW.Helper.Swagger

website

NuGet Package NuGet Downloads License <br/> Linux MacOS Windows (Visual Studio)

Features

This package provides Swagger / OpenAPI support for SimpleW.

Getting Started

The minimal API

using SimpleW;
using SimpleW.Observability;
using SimpleW.Helper.Swagger;

namespace Sample {
    class Program {

        static async Task Main() {

            // debug log
            Log.SetSink(Log.ConsoleWriteLine, LogLevel.Debug);

            // listen to all IPs port 2015
            var server = new SimpleWServer(IPAddress.Any, 2015);

            server.MapGet("/api/test", () => {
                return new { message = "Hello World !" };
            });

            server.MapGet("/swagger.json", static (HttpSession session) => {
                return Swagger.Json(session, options => {
                    options.Title = "My API";
                    options.Version = "v1";
                });
            });

            server.MapGet("/admin/swagger", static (HttpSession session) => {
                return Swagger.Ui(session, "/swagger.json", options => {
                    options.Title = "My API";
                    options.Version = "v1";
                });
            });

            // start a blocking background server
            await server.RunAsync();
        }
    }

}

Open http://localhost:{server.Port}/admin/swagger to see Swagger UI or http://localhost:{server.Port}/swagger.json for the json version only

Documentation

To check out docs, visit simplew.net.

Changelog

Detailed changes for each release are documented in the CHANGELOG.

Contribution

Feel free to report issue.

License

This library is under the MIT License.

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 is compatible.  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 is compatible.  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.

  • net10.0

    • SimpleW (>= 26.0.0-rc.20260312-1555)

  • net8.0

    • SimpleW (>= 26.0.0-rc.20260312-1555)

  • net9.0

    • SimpleW (>= 26.0.0-rc.20260312-1555)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.