blacksalt/kube-swagger repository overview

⁠Getting started

⁠Quick try

See deployment.png in the repo or run

docker run --rm -it -p 8080:8080 -e MASTER_API_SWAGGER_URL=https://console.starter-ca-central-1.openshift.com/swaggerapi janosroden/oc-swagger

Then go to http://localhost:8080/⁠

⁠Environment variables

• MASTER_API_SWAGGER_URL: Your swagger endpoint, for me it's https://example.cloud:8443/swaggerapi⁠
• KEEP_API_CALLS: false by default, which means the REST API paths will be removed, you can browse the object models only. Keep in mind you can't use swagger's 'Try it' feature due to the missing auth token.

⁠Build your own image and deploy to the cluster

oc new-app swagger --env MASTER_API_SWAGGER_URL=https://example.cloud:8443/swaggerapi --env KEEP_API_CALLS=false https://github.com/janosroden/oc-swagger.git

Then create a route and browse.

⁠Use existing dockerhub image and deploy to the cluster

oc new-app --env MASTER_API_SWAGGER_URL=https://example.cloud:8443/swaggerapi --env KEEP_API_CALLS=false janosroden/oc-swagger

Then create a route and browse.

⁠Run it locally

docker run -d -p 8080:8080 -e KEEP_API_CALLS=false -e MASTER_API_SWAGGER_URL=https://example.cloud:8443/swaggerapi janosroden/oc-swagger

Then go to http://localhost:8080/⁠

⁠How it works?

At the start of the container api-spec-converter⁠ converts $MASTER_API_SWAGGER_URL to swagger 2.0 format. Then depending on $KEEP_API_CALLS it removes the REST API paths from the swagger file with jq⁠. Finally the http-server⁠ serves the static files.