openapi2excel.cli 0.0.3

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global openapi2excel.cli --version 0.0.3
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 openapi2excel.cli --version 0.0.3
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=openapi2excel.cli&version=0.0.3
                    


                    

                
nuke :add-package openapi2excel.cli --version 0.0.3

OpenAPI-2-Excel

<div align="center"> <img src="assets/logo.png" width="250px"> </div>

<div align="center">

🚧 - Under Development NuGet Package NuGet Package GitHub license

</div>

Tool to generate Rest API specification in a MS Excel format - human friendly document from Swagger/OpenAPI spec in YAML or JSON. The result should be accessible to Business Analyst and software developers.

[!NOTE]

This project is part of the "100 Commits" competition, whose main purpose is is to develop an original Open Source project for 100 days.

Installation

Download and install the one of the currently supported .NET SDKs. Once installed, run the following command:

dotnet tool install --global openapi2excel.cli

Usage



    ██████╗ ██████╗ ███████╗███╗   ██╗ █████╗ ██████╗ ██╗    ██████╗     ███████╗██╗  ██╗ ██████╗███████╗██╗
   ██╔═══██╗██╔══██╗██╔════╝████╗  ██║██╔══██╗██╔══██╗██║    ╚════██╗    ██╔════╝╚██╗██╔╝██╔════╝██╔════╝██║
   ██║   ██║██████╔╝█████╗  ██╔██╗ ██║███████║██████╔╝██║     █████╔╝    █████╗   ╚███╔╝ ██║     █████╗  ██║
   ██║   ██║██╔═══╝ ██╔══╝  ██║╚██╗██║██╔══██║██╔═══╝ ██║    ██╔═══╝     ██╔══╝   ██╔██╗ ██║     ██╔══╝  ██║
   ╚██████╔╝██║     ███████╗██║ ╚████║██║  ██║██║     ██║    ███████╗    ███████╗██╔╝ ██╗╚██████╗███████╗███████╗
    ╚═════╝ ╚═╝     ╚══════╝╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝     ╚═╝    ╚══════╝    ╚══════╝╚═╝  ╚═╝ ╚═════╝╚══════╝╚══════╝


DESCRIPTION:
Generate Rest API specification in a MS Excel format

USAGE:
    OpenApi 2 Excel <INPUT_FILE> <OUTPUT_FILE> [OPTIONS]

ARGUMENTS:
    <INPUT_FILE>     The path or URL to a YAML or JSON file with Rest API specification
    <OUTPUT_FILE>    The path for output excel file

OPTIONS:
    -h, --help       Prints help information
    -v, --version    Prints version information

Example

  openapi2excel C:\openapi-spec.yml C:\openapi-spec.xlsx

Wrap Up

If you think the repository can be improved, please open a PR with any updates and submit any issues.

Contribution

  • Open a pull request with improvements
  • Discuss ideas in issues

License

GitHub license

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 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 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
0.1.8 473 11/4/2024
0.1.7 124 11/1/2024
0.1.6 110 10/27/2024
0.1.5 129 10/21/2024
0.1.4 109 10/21/2024
0.1.3 100 10/21/2024
0.1.2 122 10/20/2024
0.1.1 331 5/27/2024
0.1.0 137 5/22/2024
0.0.6 158 5/17/2024
0.0.5 141 5/11/2024
0.0.4 144 5/7/2024
0.0.3 145 4/17/2024
0.0.2 208 4/12/2024
0.0.1 194 4/8/2024

See https://github.com/pszybiak/openapi-2-excel/blob/main/CHANGELOG.md# for release notes.