Caligo.SqlToOpenApi3Schemas 1.1.2

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher. 
dotnet tool install --global Caligo.SqlToOpenApi3Schemas --version 1.1.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local Caligo.SqlToOpenApi3Schemas --version 1.1.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Caligo.SqlToOpenApi3Schemas&version=1.1.2
                    


                    

                
nuke :add-package Caligo.SqlToOpenApi3Schemas --version 1.1.2

Caligo.SqlToOpenApi3Schemas

This is a command-line tool that extracts schema information from a Microsoft SQL Server database and generates the schemas.yaml to be used in an OpenAPI 3 specification.

Bugs

Please report any bugs on Github: https://github.com/caligo-erik/MSSqlToOpenApi3Schemas/issues

Usage

Once Caligo.SqlToOpenApi3Schemas is installed, you can use it from the command line as follows:

SqlToOpenApi3Schemas -c "your-connection-string"

Optional parameters

Database schema

You can specify a specific database schema, and the extractor will only extract the schema information for the specified schema:

SqlToOpenApi3Schemas -c "your-connection-string" -s your-schema

If no schema is specified, the default schema assigned to the login will be used, typically dbo.

Output path

You can also specify the output path for the schemas.yaml file:

SqlToOpenApi3Schemas -c "your-connection-string" -o outputPath

CRUD paths

You can specify the fileName and prefix for the crud paths

SqlToOpenApi3Schemas -c "your-connection-string" --pathPrefix /api/data --paths pathsFileName
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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.  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.

This package has no dependencies.

Version Downloads Last Updated
1.1.2 505 11/8/2023
1.1.1 291 11/8/2023
1.1.0 321 11/3/2023
1.0.6 406 11/3/2023
1.0.5 436 10/26/2023
1.0.4 394 10/26/2023
1.0.3 367 10/26/2023
1.0.2 363 10/10/2023
1.0.1 382 10/10/2023
1.0.0 329 10/10/2023
0.0.3 364 10/9/2023
0.0.2 253 10/9/2023
0.0.1 274 10/9/2023

ReleaseNotes.md