LIGHT

  • News
  • Docs
  • Community
  • Reddit
  • GitHub

Swagger Cli

Swagger cli to bundle and validate specification files

When editing the swagger specification file, naturally we will be using yaml format as it is very easy to read and manipulate. Also, we might extract common definitions into separate files so that there is no duplications for multiple APIs. For the light-codegen, however, it requires one single swagger.json as model input. To generate a single json formatted specification file, we can use the Swagger 2.0 command-line tool.

  • Supports multi-file APIs via $ref pointers
  • Validates Swagger 2.0 APIs in JSON or YAML format
  • Bundles multiple Swagger files into one combined Swagger file
  • Built-in HTTP server to serve your REST API

Note: that you don’t need this tool if your specification file is a self contained yaml file in swagger-editor. You can export into json format and it is validated already during the export process.

Installation

The tool can be found at the following location: swagger-cli

Install using npm:

npm install -g swagger-cli

General Usage

swagger [options]

Commands:

  • validate: Validates a Swagger API against the Swagger 2.0 schema and spec
  • bundle: Bundles a multi-file Swagger API into a single file
  • serve: Serves a Swagger API via the built-in HTTP REST server

Options:

  • -h, –help: Show help for any command
  • -V, –version: Output the CLI version number
  • -d, –debug [filter]: Show debug output, optionally filtered (ex.: “”, “swagger:”, etc.)

As we have a repo of model and config for light-codegen. It would be easier to provide an example based on our folder structure.

Command line

If you prefer to run the commands individually, please see the sequence listed below:

# clone the model-config GIT repository
git clone https://github.com/networknt/model-config.git

# switch to the rest folder
cd model-config/rest

# switch to one of the API folders
# ex.: cd petstore
cd <api name>

#copy common definitions to the api folder
cp -r ../common .

# execute the bundling functionlity
swagger bundle -o swagger.json -r swagger.yaml

# validate the definition against the Open API spec
swagger validate swagger.json

# clean-up
rm -r common

# use the generated swagger.json file with the swagger-codegen project to generate server stubs

Script

The above command line steps are very easy to understand but are not the most convenient way to bundle and validate yaml files. Here is another way that leverages a script in model-config/rest folder.

Note: the script assume that the common definition is defined in common folder and all API specification are defined in a folder name as the API name.

Run the bundle.sh script to bundle and validate
# clone the model-config repository
git clone https://github.com/networknt/model-config.git

# switch to the model-config/rest folder
cd model-config/rest

# run the bundle script
# ./bundle.sh <api name>
# ex.: ./bundle.sh petstore
./bundle.sh <api name>
  • About Light
    • Overview
    • Testimonials
    • What is Light
    • Features
    • Principles
    • Benefits
    • Roadmap
    • Community
    • Articles
    • Videos
    • License
    • Why Light Platform
  • Getting Started
    • Get Started Overview
    • Environment
    • Light Codegen Tool
    • Light Rest 4j
    • Light Tram 4j
    • Light Graphql 4j
    • Light Hybrid 4j
    • Light Eventuate 4j
    • Light Oauth2
    • Light Portal Service
    • Light Proxy Server
    • Light Router Server
    • Light Config Server
    • Light Saga 4j
    • Light Session 4j
    • Webserver
    • Websocket
    • Spring Boot Servlet
  • Architecture
    • Architecture Overview
    • API Category
    • API Gateway
    • Architecture Patterns
    • CQRS
    • Eco System
    • Event Sourcing
    • Fail Fast vs Fail Slow
    • Integration Patterns
    • JavaEE declining
    • Key Distribution
    • Microservices Architecture
    • Microservices Monitoring
    • Microservices Security
    • Microservices Traceability
    • Modular Monolith
    • Platform Ecosystem
    • Plugin Architecture
    • Scalability and Performance
    • Serverless
    • Service Collaboration
    • Service Mesh
    • SOA
    • Spring is bloated
    • Stages of API Adoption
    • Transaction Management
    • Microservices Cross-cutting Concerns Options
    • Service Mesh Plus
    • Service Discovery
  • Design
    • Design Overview
    • Design First vs Code First
    • Desgin Pattern
    • Service Evolution
    • Consumer Contract and Consumer Driven Contract
    • Handling Partial Failure
    • Idempotency
    • Server Life Cycle
    • Environment Segregation
    • Database
    • Decomposition Patterns
    • Http2
    • Test Driven
    • Multi-Tenancy
    • Why check token expiration
    • WebServices to Microservices
  • Cross-Cutting Concerns
    • Concerns Overview
  • API Styles
    • Light-4j for absolute performance
    • Style Overview
    • Distributed session on IMDG
    • Hybrid Serverless Modularized Monolithic
    • Kafka - Event Sourcing and CQRS
    • REST - Representational state transfer
    • Web Server with Light
    • Websocket with Light
    • Spring Boot Integration
    • Single Page Application
    • GraphQL - A query language for your API
    • Light IBM MQ
    • Light AWS Lambda
    • Chaos Monkey
  • Infrastructure Services
    • Service Overview
    • Light Proxy
    • Light Mesh
    • Light Router
    • Light Portal
    • Messaging Infrastructure
    • Centralized Logging
    • COVID-19
    • Light OAuth2
    • Metrics and Alerts
    • Config Server
    • Tokenization
    • Light Controller
  • Tool Chain
    • Tool Chain Overview
  • Utility Library
  • Service Consumer
    • Service Consumer
  • Development
    • Development Overview
  • Deployment
    • Deployment Overview
    • Frontend Backend
    • Linux Service
    • Windows Service
    • Install Eventuate on Windows
    • Secure API
    • Client vs light-router
    • Memory Limit
    • Deploy to Kubernetes
  • Benchmark
    • Benchmark Overview
  • Tutorial
    • Tutorial Overview
  • Troubleshooting
    • Troubleshoot
  • FAQ
    • FAQ Overview
  • Milestones
  • Contribute
    • Contribute to Light
    • Development
    • Documentation
    • Example
    • Tutorial
“Swagger Cli” was last updated: July 5, 2021: fixes #275 checked and corrected grammar/spelling for majority of pages (#276) (b3bbb7b)
Improve this page
  • News
  • Docs
  • Community
  • Reddit
  • GitHub
  • About Light
  • Getting Started
  • Architecture
  • Design
  • Cross-Cutting Concerns
  • API Styles
  • Infrastructure Services
  • Tool Chain
  • Utility Library
  • Service Consumer
  • Development
  • Deployment
  • Benchmark
  • Tutorial
  • Troubleshooting
  • FAQ
  • Milestones
  • Contribute