Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markruler/swage
OpenAPI Specification v2.0 to Excel
https://github.com/markruler/swage
oas openapi openapi-specification swagger xlsx
Last synced: 8 days ago
JSON representation
OpenAPI Specification v2.0 to Excel
- Host: GitHub
- URL: https://github.com/markruler/swage
- Owner: markruler
- License: mit
- Created: 2021-03-23T12:04:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-08T00:07:22.000Z (over 3 years ago)
- Last Synced: 2024-10-31T10:51:28.518Z (15 days ago)
- Topics: oas, openapi, openapi-specification, swagger, xlsx
- Language: Go
- Homepage:
- Size: 2.26 MB
- Stars: 10
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swage
> Command line tool to convert OpenAPI specification data (`json`, `yaml`) to Excel (`xlsx`) format
## Install
- [Releases](https://github.com/markruler/swage/releases)
```bash
cd /tmp
# curl -LO https://github.com/markruler/swage/releases/download/v0.2.2/swage_v0.2.2_$(uname -s)_$(uname -p).tar.gz
wget https://github.com/markruler/swage/releases/download/v0.2.2/swage_v0.2.2_$(uname -s)_$(uname -p).tar.gz
tar zxvf swage_v0.2.2_$(uname -s)_$(uname -p).tar.gz
sudo mv swage /usr/local/bin/swage
```
```bash
swage version
```
## Usage
```bash
swage gen
```
```bash
# file path
swage gen testdata/yaml/docker.v1.41.yaml
```
```bash
# URL path
swage gen https://docs.docker.com/engine/api/v1.41.yaml
swage gen https://raw.githubusercontent.com/kubernetes/kubernetes/v1.20.5/api/openapi-spec/swagger.json
```
## Background
### OAS
- [Swagger - SmartBear Software](https://swagger.io/docs/specification/about)
- [OpenAPI - The Linux Foundation](https://www.openapis.org/about)
- OpenAPI Specification (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API.
### XLSX extension
- [MS-XLSX Standard](https://docs.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/)
- The Excel (.xlsx) Extensions to the Office Open XML SpreadsheetML File Format specifies extensions
to the Office Open XML file formats described in [ISO/IEC29500-1:2016](https://www.iso.org/standard/71691.html).
The extensions are specified using conventions provided by the Office Open XML file formats
described in [ISO/IEC29500-3:2015](https://www.iso.org/standard/65533.html).
## Dependencies
- [spf13/cobra](https://github.com/spf13/cobra)
- [go-openapi/spec](https://github.com/go-openapi/spec)
- [go-openapi/loads](https://github.com/go-openapi/loads)
- [360EntSecGroup-Skylar/excelize](https://github.com/360EntSecGroup-Skylar/excelize)
## References
- [SmartBear Documentations](https://swagger.io/docs/specification)
- [OAI OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification)
- [APIs.guru](https://apis.guru/browse-apis/)
- [APIs.guru - GitHub](https://github.com/APIs-guru/openapi-directory)
## Open API Specification (OAS) Revision History
- [OpenAPI Specification - Appendix A: Revision History](https://swagger.io/specification/#appendix-a-revision-history)
- by SmartBear
| Version | Date | Notes |
| --------- | ---------- | ------------------------------------------------- |
| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 |
| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 |
| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 |
| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 |
| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification |
| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification |
| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification |
| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative |
| 2.0 | 2014-09-08 | Release of Swagger 2.0 |
| 1.2 | 2014-03-14 | Initial release of the formal document. |
| 1.1 | 2012-08-22 | Release of Swagger 1.1 |
| 1.0 | 2011-08-10 | First release of the Swagger Specification |
_[A Guide to What’s New in OpenAPI 3.0](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) - Ryan Pinkham_