mirror of
https://github.com/portainer/portainer.git
synced 2025-07-21 06:19:41 +02:00
50b57614cf
* feat(api): introduce swagger * feat(api): anottate api * chore(api): tag endpoints * chore(api): remove tags * chore(api): add docs for oauth auth * chore(api): document create endpoint api * chore(api): document endpoint inspect and list * chore(api): document endpoint update and snapshots * docs(endpointgroups): document groups api * docs(auth): document auth api * chore(build): introduce a yarn script to build api docs * docs(api): document auth * docs(customtemplates): document customtemplates api * docs(tags): document api * docs(api): document the use of token * docs(dockerhub): document dockerhub api * docs(edgegroups): document edgegroups api * docs(edgejobs): document api * docs(edgestacks): doc api * docs(http/upload): add security * docs(api): document edge templates * docs(edge): document edge jobs * docs(endpointgroups): change description * docs(endpoints): document missing apis * docs(motd): doc api * docs(registries): doc api * docs(resourcecontrol): api doc * docs(role): add swagger docs * docs(settings): add swagger docs * docs(api/status): add swagger docs * docs(api/teammembership): add swagger docs * docs(api/teams): add swagger docs * docs(api/templates): add swagger docs * docs(api/users): add swagger docs * docs(api/webhooks): add swagger docs * docs(api/webscokets): add swagger docs * docs(api/stacks): swagger * docs(api): fix missing apis * docs(swagger): regen * chore(build): remove docs from build * docs(api): update tags * docs(api): document tags * docs(api): add description * docs(api): rename jwt token * docs(api): add info about types * docs(api): document types * docs(api): update request types annotation * docs(api): doc registry and resource control * chore(docs): add snippet * docs(api): add description to role * docs(api): add types for settings * docs(status): add types * style(swagger): remove documented code * docs(http/upload): update docs with types * docs(http/tags): add types * docs(api/custom_templates): add types * docs(api/teammembership): add types * docs(http/teams): add types * docs(http/stacks): add types * docs(edge): add types to edgestack * docs(http/teammembership): remove double returns * docs(api/user): add types * docs(http): fixes to make file built * chore(snippets): add scope to swagger snippet * chore(deps): install swag * chore(swagger): remove handler * docs(api): add description * docs(api): ignore docs folder * docs(api): add contributing guidelines * docs(api): cleanup handler * chore(deps): require swaggo * fix(auth): fix typo * fix(docs): make http ids pascal case * feat(edge): add ids to http handlers * fix(docs): add ids * fix(docs): show correct api version * chore(deps): remove swaggo dependency * chore(docs): add install script for swag
207 lines
8.6 KiB
Go
207 lines
8.6 KiB
Go
package handler
|
|
|
|
import (
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/portainer/portainer/api/http/handler/auth"
|
|
"github.com/portainer/portainer/api/http/handler/customtemplates"
|
|
"github.com/portainer/portainer/api/http/handler/dockerhub"
|
|
"github.com/portainer/portainer/api/http/handler/edgegroups"
|
|
"github.com/portainer/portainer/api/http/handler/edgejobs"
|
|
"github.com/portainer/portainer/api/http/handler/edgestacks"
|
|
"github.com/portainer/portainer/api/http/handler/edgetemplates"
|
|
"github.com/portainer/portainer/api/http/handler/endpointedge"
|
|
"github.com/portainer/portainer/api/http/handler/endpointgroups"
|
|
"github.com/portainer/portainer/api/http/handler/endpointproxy"
|
|
"github.com/portainer/portainer/api/http/handler/endpoints"
|
|
"github.com/portainer/portainer/api/http/handler/file"
|
|
"github.com/portainer/portainer/api/http/handler/motd"
|
|
"github.com/portainer/portainer/api/http/handler/registries"
|
|
"github.com/portainer/portainer/api/http/handler/resourcecontrols"
|
|
"github.com/portainer/portainer/api/http/handler/roles"
|
|
"github.com/portainer/portainer/api/http/handler/settings"
|
|
"github.com/portainer/portainer/api/http/handler/stacks"
|
|
"github.com/portainer/portainer/api/http/handler/status"
|
|
"github.com/portainer/portainer/api/http/handler/tags"
|
|
"github.com/portainer/portainer/api/http/handler/teammemberships"
|
|
"github.com/portainer/portainer/api/http/handler/teams"
|
|
"github.com/portainer/portainer/api/http/handler/templates"
|
|
"github.com/portainer/portainer/api/http/handler/upload"
|
|
"github.com/portainer/portainer/api/http/handler/users"
|
|
"github.com/portainer/portainer/api/http/handler/webhooks"
|
|
"github.com/portainer/portainer/api/http/handler/websocket"
|
|
)
|
|
|
|
// Handler is a collection of all the service handlers.
|
|
type Handler struct {
|
|
AuthHandler *auth.Handler
|
|
CustomTemplatesHandler *customtemplates.Handler
|
|
DockerHubHandler *dockerhub.Handler
|
|
EdgeGroupsHandler *edgegroups.Handler
|
|
EdgeJobsHandler *edgejobs.Handler
|
|
EdgeStacksHandler *edgestacks.Handler
|
|
EdgeTemplatesHandler *edgetemplates.Handler
|
|
EndpointEdgeHandler *endpointedge.Handler
|
|
EndpointGroupHandler *endpointgroups.Handler
|
|
EndpointHandler *endpoints.Handler
|
|
EndpointProxyHandler *endpointproxy.Handler
|
|
FileHandler *file.Handler
|
|
MOTDHandler *motd.Handler
|
|
RegistryHandler *registries.Handler
|
|
ResourceControlHandler *resourcecontrols.Handler
|
|
RoleHandler *roles.Handler
|
|
SettingsHandler *settings.Handler
|
|
StackHandler *stacks.Handler
|
|
StatusHandler *status.Handler
|
|
TagHandler *tags.Handler
|
|
TeamMembershipHandler *teammemberships.Handler
|
|
TeamHandler *teams.Handler
|
|
TemplatesHandler *templates.Handler
|
|
UploadHandler *upload.Handler
|
|
UserHandler *users.Handler
|
|
WebSocketHandler *websocket.Handler
|
|
WebhookHandler *webhooks.Handler
|
|
}
|
|
|
|
// @title PortainerCE API
|
|
// @version 2.1.1
|
|
// @description.markdown api-description.md
|
|
// @termsOfService
|
|
|
|
// @contact.email info@portainer.io
|
|
|
|
// @license.name
|
|
// @license.url
|
|
|
|
// @host
|
|
// @BasePath /api
|
|
// @schemes http https
|
|
|
|
// @securitydefinitions.apikey jwt
|
|
// @in header
|
|
// @name Authorization
|
|
|
|
// @tag.name auth
|
|
// @tag.description Authenticate against Portainer HTTP API
|
|
// @tag.name custom_templates
|
|
// @tag.description Manage Custom Templates
|
|
// @tag.name dockerhub
|
|
// @tag.description Manage how Portainer connects to the DockerHub
|
|
// @tag.name edge_groups
|
|
// @tag.description Manage Edge Groups
|
|
// @tag.name edge_jobs
|
|
// @tag.description Manage Edge Jobs
|
|
// @tag.name edge_stacks
|
|
// @tag.description Manage Edge Stacks
|
|
// @tag.name edge_templates
|
|
// @tag.description Manage Edge Templates
|
|
// @tag.name edge
|
|
// @tag.description Manage Edge related endpoint settings
|
|
// @tag.name endpoints
|
|
// @tag.description Manage Docker environments
|
|
// @tag.name endpoint_groups
|
|
// @tag.description Manage endpoint groups
|
|
// @tag.name motd
|
|
// @tag.description Fetch the message of the day
|
|
// @tag.name registries
|
|
// @tag.description Manage Docker registries
|
|
// @tag.name resource_controls
|
|
// @tag.description Manage access control on Docker resources
|
|
// @tag.name roles
|
|
// @tag.description Manage roles
|
|
// @tag.name settings
|
|
// @tag.description Manage Portainer settings
|
|
// @tag.name status
|
|
// @tag.description Information about the Portainer instance
|
|
// @tag.name stacks
|
|
// @tag.description Manage Docker stacks
|
|
// @tag.name users
|
|
// @tag.description Manage users
|
|
// @tag.name tags
|
|
// @tag.description Manage tags
|
|
// @tag.name teams
|
|
// @tag.description Manage teams
|
|
// @tag.name team_memberships
|
|
// @tag.description Manage team memberships
|
|
// @tag.name templates
|
|
// @tag.description Manage App Templates
|
|
// @tag.name stacks
|
|
// @tag.description Manage stacks
|
|
// @tag.name upload
|
|
// @tag.description Upload files
|
|
// @tag.name webhooks
|
|
// @tag.description Manage webhooks
|
|
// @tag.name websocket
|
|
// @tag.description Create exec sessions using websockets
|
|
|
|
// ServeHTTP delegates a request to the appropriate subhandler.
|
|
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
switch {
|
|
case strings.HasPrefix(r.URL.Path, "/api/auth"):
|
|
http.StripPrefix("/api", h.AuthHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/dockerhub"):
|
|
http.StripPrefix("/api", h.DockerHubHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/custom_templates"):
|
|
http.StripPrefix("/api", h.CustomTemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_stacks"):
|
|
http.StripPrefix("/api", h.EdgeStacksHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_groups"):
|
|
http.StripPrefix("/api", h.EdgeGroupsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_jobs"):
|
|
http.StripPrefix("/api", h.EdgeJobsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_stacks"):
|
|
http.StripPrefix("/api", h.EdgeStacksHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_templates"):
|
|
http.StripPrefix("/api", h.EdgeTemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/endpoint_groups"):
|
|
http.StripPrefix("/api", h.EndpointGroupHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/endpoints"):
|
|
switch {
|
|
case strings.Contains(r.URL.Path, "/docker/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/kubernetes/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/storidge/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/azure/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/edge/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointEdgeHandler).ServeHTTP(w, r)
|
|
default:
|
|
http.StripPrefix("/api", h.EndpointHandler).ServeHTTP(w, r)
|
|
}
|
|
case strings.HasPrefix(r.URL.Path, "/api/motd"):
|
|
http.StripPrefix("/api", h.MOTDHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/registries"):
|
|
http.StripPrefix("/api", h.RegistryHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/resource_controls"):
|
|
http.StripPrefix("/api", h.ResourceControlHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/roles"):
|
|
http.StripPrefix("/api", h.RoleHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/settings"):
|
|
http.StripPrefix("/api", h.SettingsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/stacks"):
|
|
http.StripPrefix("/api", h.StackHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/status"):
|
|
http.StripPrefix("/api", h.StatusHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/tags"):
|
|
http.StripPrefix("/api", h.TagHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/templates"):
|
|
http.StripPrefix("/api", h.TemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/upload"):
|
|
http.StripPrefix("/api", h.UploadHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/users"):
|
|
http.StripPrefix("/api", h.UserHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/teams"):
|
|
http.StripPrefix("/api", h.TeamHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/team_memberships"):
|
|
http.StripPrefix("/api", h.TeamMembershipHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/websocket"):
|
|
http.StripPrefix("/api", h.WebSocketHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/webhooks"):
|
|
http.StripPrefix("/api", h.WebhookHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/"):
|
|
h.FileHandler.ServeHTTP(w, r)
|
|
}
|
|
}
|