Code Monkey home page Code Monkey logo

swage's Introduction

Swage

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

Install

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
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

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

References

Open API Specification (OAS) Revision History

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

OAS Version

A Guide to What’s New in OpenAPI 3.0 - Ryan Pinkham

swage's People

Contributors

cxsu avatar markruler avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

cxsu bitflow-si 8mk zhlicen xavier-hernandez

swage's Issues

Schema objects as Table

I found your repo because I was looking for a conversion of openapi schema to excel table format.

I looked at the example of the docker api output.

Is there any chance, that you can extend the software, so that schema models are extracted to tables and you can link them like you do it with the operations?

It should be possible, since I am able to click through the schemas in swagger-ui

Or do you know other tools which do that?

Kind regards
Matthias

When the user provides an invalid flag or invalid command, Swage responds by showing the user the 'usage'.

  • swage gen

output:

Error: PATH is required

expected:

+
Error: PATH is required
+
+ Generate a Excel file
+
+ Usage:
+   swage gen PATH [flags]
  • swage gen --help

output:

Generate a Excel file

ex) swage gen aio/example/example.json -o $HOME/swage.xlsx

Usage:
  swage gen [PATH] [flags]

expected:

+
Generate a Excel file

- ex) swage gen aio/example/example.json -o $HOME/swage.xlsx

Usage:
-  swage gen [PATH] [flags]
+  swage gen PATH [flags]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.