Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schroedermatt/swagger-aggregate
Spring Boot app to aggregate multiple service's Swagger api-docs
https://github.com/schroedermatt/swagger-aggregate
api-docs gradle groovy spring-boot swagger swagger-ui swagger2 yml
Last synced: 2 months ago
JSON representation
Spring Boot app to aggregate multiple service's Swagger api-docs
- Host: GitHub
- URL: https://github.com/schroedermatt/swagger-aggregate
- Owner: schroedermatt
- License: mit
- Created: 2017-08-15T18:35:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-13T17:26:47.000Z (almost 6 years ago)
- Last Synced: 2024-09-30T23:03:09.505Z (3 months ago)
- Topics: api-docs, gradle, groovy, spring-boot, swagger, swagger-ui, swagger2, yml
- Language: Groovy
- Homepage:
- Size: 56.6 KB
- Stars: 24
- Watchers: 2
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Swagger Aggregate Service
Spring Boot service that can aggregate a series of microservice api-docs into a single Swagger-UI.
#### Configuration:
In the **application.yml** file, configure all microservice api-docs endpoints. This is what Swagger-UI consumes.
```
documentation:
swagger:
services:
-
name: Important Service
url: /v2/api-docs
version: 2.0
-
name: Another Service
url: /path/to/api-docs
version: 2.0
```
#### Customizing the api-docs path:
If you have multiple services running on the same port or are using a load balancer
that uses path mappings to determine the target service, you may need to customize
the path that is used to serve up the api-docs.
You can do this via the `springfox.documentation.swagger.v2.path` property.
```
// application.yml
springfox:
documentation:
swagger:
v2:
path: /path/to/api-docs
```
---
##### Footnotes
This application was bootstrapped from
* [Microservices API Documentation with Swagger2](https://piotrminkowski.wordpress.com/2017/04/14/microservices-api-documentation-with-swagger2/)
* [Microservices Single Swagger](https://github.com/varghgeorge/microservices-single-swagger)