swage

README

Swage

Command line tool to convert OpenAPI specification data (json, yaml) to Excel (xlsx) format

Install

• Releases

cd /tmp
# curl -LO https://github.com/markruler/swage/releases/download/v0.1.1/swage_v0.1.1_$(uname -s)_$(uname -p).tar.gz
wget https://github.com/markruler/swage/releases/download/v0.1.1/swage_v0.1.1_$(uname -s)_$(uname -p).tar.gz
tar zxvf swage_v0.1.1_$(uname -s)_$(uname -p).tar.gz
sudo mv swage /usr/local/bin/swage

swage version

Usage

swage gen <path>

# file path
swage gen testdata/yaml/docker.v1.41.yaml

# 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
• OpenAPI - The Linux Foundation
• 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
• 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. The extensions are specified using conventions provided by the Office Open XML file formats described in ISO/IEC29500-3:2015.

Dependencies

• spf13/cobra
• go-openapi/spec
• go-openapi/loads
• 360EntSecGroup-Skylar/excelize

References

• SmartBear Documentations
• OAI OpenAPI Specification
• APIs.guru
• APIs.guru - GitHub

Open API Specification (OAS) Revision History

• OpenAPI 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 - Ryan Pinkham