Skip to content

Small application that finds the openapi endpoints in the cluster and creates a webpage overview.

License

Notifications You must be signed in to change notification settings

mejlholm/openapi-map

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Version License

OpenAPI Map

OpenAPI Map is a kubernetes application that scrapes applications exposing OpenAPI endpoints inside your cluster and aggregates these into a single webpage for a quick overview of you services. From there you can click to the OpenAPI swagger UIs can explore further.

  • Aggregated view: Get an easy overview of the service endpoints in your namespace.
  • Simple config: Just configure the namespace it should be looking at.

OpenAPI Map

Built on Quarkus.io and a bit of angular,

Getting started

Adjust the namespace in deploy/deployment.yaml:

kubectl apply -f deploy

to automatically scrape the services in that namespace.

Avoid scraping

To avoid scraping certain services/ingresses, add the following to your metadata:

metadata:
  annotations:
    openapi-map/scrape: 'false'