Caligo.SqlToOpenApi3Schemas
1.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global Caligo.SqlToOpenApi3Schemas --version 1.1.0
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.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Caligo.SqlToOpenApi3Schemas&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Caligo.SqlToOpenApi3Schemas --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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.
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 | Versions 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
ReleaseNotes.md