Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

swagger-combine-ui

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

swagger-combine-ui

Combines multiple Swagger schemas into one site

  • 0.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6
increased by500%
Maintainers
1
Weekly downloads
 
Created
Source

Swagger Combine UI

Build Status

The service is used to combine the documentation of various services and display it.

When you should use swagger-combine-ui:

  • You have a certain number of microservices and you need to combine their Swagger into one interface

Configuration

The default path for the configuration file is ./swagger.yaml

Swagger Combine UI requires one configuration schema which resembles a standard Swagger schema except for an additional apis field.

For informations about configuration have a look at the documentation of swagger-combine.

APIs difference

url field

URL or query path to swagger apidocs. If the url field contains a path, then the full url is formed from the request headers:

  • Host header is used as the domain.
  • X-Forwarded-Proto header is used as a schema. Schema is http by default.

Docker

docker run -d -p 3000:3000 -v /path/to/swagger.yaml:/app/swagger.yaml swaggerql/swagger-combine-ui

Keywords

FAQs

Package last updated on 04 Jun 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc