Consolidated API UI

UI that allows to switch between different OpenAPI and AsyncApi schemas. This allows to build consolidated api documentation for different microservices in one place.

Installation

Use docker image:

docker pull gometric/swagger-ui-consolidated

Configuration

Application reads its configuration from config.json file located in work directory. In Docker environment workdir is /var/www/swagger-ui.

You may pass configuration in APP_CONFIG environment variable and it's content will be stored during initiation of container, or you may mount your own configuration file during build of own image.

Example configuration:

{
  "openapi": [
    {
      "slug": "amazon-api-gateway",
      "name": "Amazon Api Gateway",
      "url": "https://api.apis.guru/v2/specs/amazonaws.com/apigateway/2015-07-09/openapi.json"
    }
  ],
  "asyncapi": [
    {
      "name": "Slack Real Time Messaging API",
      "slug": "slack-messaging",
      "url": "https://raw.githubusercontent.com/asyncapi/spec/master/examples/slack-rtm.yml"
    }
  ]
}

Running in a cloud

Kubernetes

apiVersion: apps/v1
kind: Deployment
metadata:
  name: swagger-ui-deployment
spec:
  replicas: 1
  selector:
    matchLabels:
      app: swagger-ui
  template:
    metadata:
      labels:
        app: swagger-ui
    spec:
      containers:
        - name: swagger-ui
          image: gometric/swagger-ui-consolidated:latest
          ports:
            - containerPort: 80

---

apiVersion: v1
kind: Service
metadata:
  name: swagger-ui-service
spec:
  selector:
    app: swagger-ui
  ports:
    - port: 80
      protocol: TCP
      targetPort: 80
  type: LoadBalancer

Nomad job

Deploy app to Nomad cluster:

levant deploy \
    -log-level=debug \
    -address $NOMAD_ADDR_PROD \
    -var dc="$NOMAD_DC" \
    -var name="$NOMAD_JOB_NAME" \
    -var urlprefix="$PUBLIC_URL_PROD" \
    -var imageversion="$IMAGE_VERSION" \
    .nomad.standalone.job

There are two nomad file examples:

• .nomad.standalone.job - Jobs not connected with Consul Connect
• .nomad.mesh.job - Jobs connected with Consul Connect