Code Monkey home page Code Monkey logo

swagger-aggregate's Introduction

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

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.