Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/thanhson1085/swagger-combined

Combines all swagger documents in microservices
https://github.com/thanhson1085/swagger-combined

microservice proxy swagger-documentation

Last synced: 3 months ago
JSON representation

Combines all swagger documents in microservices

Host: GitHub
URL: https://github.com/thanhson1085/swagger-combined
Owner: thanhson1085
License: mit
Created: 2015-08-10T10:39:00.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2020-01-07T16:25:40.000Z (over 4 years ago)
Last Synced: 2024-03-18T06:03:32.752Z (3 months ago)
Topics: microservice, proxy, swagger-documentation
Language: JavaScript
Homepage:
Size: 2.82 MB
Stars: 110
Watchers: 11
Forks: 29
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-list-microservice - swagger-combined

README

[![Build Status](https://travis-ci.org/thanhson1085/swagger-combined.svg)](https://travis-ci.org/thanhson1085/swagger-combined)

[![NPM](https://nodei.co/npm/swagger-combined.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/swagger-combined/)

If you are building a microservice system and using Swagger.

This packet is able to help you combine all swagger documents to only one document.

For example, you have the swagger documents at `http://service1/docs`, `http://service2/docs`

This will help you combine all links above to only one link `http://service/docs`

**NOTE: If you need Gulp, ES6 and somethings more, please see branch [added_gulp](https://github.com/thanhson1085/swagger-combined/tree/added_gulp)**

### Installation & Run from Docker
```
docker run -d -p 3000:3000 thanhson1085/swagger-combined
```

### Configuration file
See config/default.json as below:
```
{
"list_url": [
{
"docs": "http://petstore.swagger.io/v2/swagger.json",
"base_path": "http://petstore.swagger.io/v2",
"route_match": ["/user*", "/pet*", "/store*"]
}
],
"info": { "title": "Example API", "version": "1.0" },
"port": 3000
}
```
- docs: swagger document links
- base_path: Proxy Target
- route_match: Routes for proxy

Please make note that you changed `config/default.json` to match all swagger document links you have

### Installation & Run from Source Code
```
git clone https://github.com/thanhson1085/swagger-combined.git
```
Run:
```
cd swagger-combined
npm install
node index.js
```

### Test
In the default, swagger-combined run on port 3000 and included swagger-ui. So you just run `http://localhost:3000?url=http://localhost:3000/docs` to see everything you need. Or you can see swagger api at `http://localhost:3000/docs`

### Example & Demo
With config/default.json:
```
{
"list_url": [
{
"docs": "http://petstore.swagger.io/v2/swagger.json",
"base_path": "http://petstore.swagger.io/v2",
"route_match": ["/user*", "/pet*", "/store*"]
},
{
"docs": "https://angular-admin-seed.sonnguyen.ws/docs",
"base_path": "https://angular-admin-seed.sonnguyen.ws",
"route_match": ["/api/v1*"]
}
],
"info": { "title": "Example API", "version": "1.0" },
"port": 3000
}
```