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.
Download and install the one of the currently supported .NET SDKs. Once installed, run the following command:
dotnet tool install --global openapi2excel.cli
Example
openapi2excel C:\openapi-spec.yml C:\openapi-spec.xlsx
To show how the application works, let's use the official example used on the Swagger Editor website.
openapi2excel https://raw.githubusercontent.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.
If you think the repository can be improved, please open a PR with any updates and submit any issues.
- Open a pull request with improvements
- Discuss ideas in issues
