Skip to content

Tool to generate Rest API specification in a MS Excel format - human friendly document from Swagger/OpenAPI spec in YAML or JSON.

License

Notifications You must be signed in to change notification settings

pszybiak/openapi-2-excel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenAPI-2-Excel

🚧 - Under Development NuGet Package NuGet Package GitHub license

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

Example

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

Result

To show how the application works, let's use the official example used on the Swagger Editor website.

  openapi2excel https://github.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml C:\openapi.xlsx

The first tab is an information tab, presenting document details and a list of available operations.

The next tabs contain details of individual operation.

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

About

Tool to generate Rest API specification in a MS Excel format - human friendly document from Swagger/OpenAPI spec in YAML or JSON.

Resources

License

Stars

Watchers

Forks

Languages