From 4bb55161e95d9c28928210b92b9cd2bacaa7768b Mon Sep 17 00:00:00 2001 From: Jhon Honce Date: Mon, 3 Feb 2020 16:47:52 -0700 Subject: Add /swagger/ endpoint to serve swagger yaml to clients The provided yaml file will describe the current Podman REST API. Signed-off-by: Jhon Honce --- pkg/api/server/register_swagger.go | 26 ++++++++++++++++++++++++++ pkg/api/server/server.go | 1 + 2 files changed, 27 insertions(+) create mode 100644 pkg/api/server/register_swagger.go (limited to 'pkg/api/server') diff --git a/pkg/api/server/register_swagger.go b/pkg/api/server/register_swagger.go new file mode 100644 index 000000000..5564ec096 --- /dev/null +++ b/pkg/api/server/register_swagger.go @@ -0,0 +1,26 @@ +package server + +import ( + "net/http" + "os" + + "github.com/gorilla/mux" +) + +// DefaultPodmanSwaggerSpec provides the default path to the podman swagger spec file +const DefaultPodmanSwaggerSpec = "/usr/share/containers/podman/swagger.yaml" + +// RegisterSwaggerHandlers maps the swagger endpoint for the server +func (s *APIServer) RegisterSwaggerHandlers(r *mux.Router) error { + // This handler does _*NOT*_ provide an UI rather just a swagger spec that an UI could render + r.PathPrefix("/swagger/").HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + path := DefaultPodmanSwaggerSpec + if p, found := os.LookupEnv("PODMAN_SWAGGER_SPEC"); found { + path = p + } + w.Header().Set("Content-Type", "text/yaml") + + http.ServeFile(w, r, path) + }) + return nil +} diff --git a/pkg/api/server/server.go b/pkg/api/server/server.go index 7bb0f5481..69f04034d 100644 --- a/pkg/api/server/server.go +++ b/pkg/api/server/server.go @@ -113,6 +113,7 @@ func newServer(runtime *libpod.Runtime, duration time.Duration, listener *net.Li server.registerPingHandlers, server.RegisterPluginsHandlers, server.registerPodsHandlers, + server.RegisterSwaggerHandlers, server.RegisterSwarmHandlers, server.registerSystemHandlers, server.registerVersionHandlers, -- cgit v1.2.3-54-g00ecf