From 42fb42ae8348397c2811a2484ac4d93467e882aa Mon Sep 17 00:00:00 2001 From: Sokil Date: Thu, 30 Dec 2021 22:50:58 +0200 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 3504cc3..9d56708 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,27 @@ This allows to build consolidated api documentation for different microservices ![Opcache dashboard](https://github.com/GoMetric/swagger-ui-consolidated/blob/master/docs/ui.png?raw=true&1) +## Configuration +To configure your own api copy configuration to `config.json`. + +Example configuration: + +```json +{ + "schemas": [ + { + "name": "Petstore", + "url": "https://petstore.swagger.io/v2/swagger.json" + }, + { + "name": "Amazon Api Gateway", + "url": "https://api.apis.guru/v2/specs/amazonaws.com/apigateway/2015-07-09/openapi.json" + }, + { + "name": "Amazon AppConfig", + "url": "https://api.apis.guru/v2/specs/amazonaws.com/appconfig/2019-10-09/openapi.json" + } + ] +} +```