| 1 |
/* |
| 2 |
Copyright 2016 The Kubernetes Authors. |
| 3 |
|
| 4 |
Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 |
you may not use this file except in compliance with the License. |
| 6 |
You may obtain a copy of the License at |
| 7 |
|
| 8 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
|
| 10 |
Unless required by applicable law or agreed to in writing, software |
| 11 |
distributed under the License is distributed on an "AS IS" BASIS, |
| 12 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 |
See the License for the specific language governing permissions and |
| 14 |
limitations under the License. |
| 15 |
*/ |
| 16 |
|
| 17 |
package routes |
| 18 |
|
| 19 |
import ( |
| 20 |
restful "github.com/emicklei/go-restful/v3" |
| 21 |
"k8s.io/klog/v2" |
| 22 |
|
| 23 |
"k8s.io/apiserver/pkg/server/mux" |
| 24 |
builder2 "k8s.io/kube-openapi/pkg/builder" |
| 25 |
"k8s.io/kube-openapi/pkg/builder3" |
| 26 |
"k8s.io/kube-openapi/pkg/common" |
| 27 |
"k8s.io/kube-openapi/pkg/common/restfuladapter" |
| 28 |
"k8s.io/kube-openapi/pkg/handler" |
| 29 |
"k8s.io/kube-openapi/pkg/handler3" |
| 30 |
"k8s.io/kube-openapi/pkg/validation/spec" |
| 31 |
) |
| 32 |
|
| 33 |
// OpenAPI installs spec endpoints for each web service. |
| 34 |
type OpenAPI struct { |
| 35 |
Config *common.Config |
| 36 |
V3Config *common.OpenAPIV3Config |
| 37 |
} |
| 38 |
|
| 39 |
// Install adds the SwaggerUI webservice to the given mux. |
| 40 |
func (oa OpenAPI) InstallV2(c *restful.Container, mux *mux.PathRecorderMux) (*handler.OpenAPIService, *spec.Swagger) { |
| 41 |
spec, err := builder2.BuildOpenAPISpecFromRoutes(restfuladapter.AdaptWebServices(c.RegisteredWebServices()), oa.Config) |
| 42 |
if err != nil { |
| 43 |
klog.Fatalf("Failed to build open api spec for root: %v", err) |
| 44 |
} |
| 45 |
spec.Definitions = handler.PruneDefaults(spec.Definitions) |
| 46 |
openAPIVersionedService := handler.NewOpenAPIService(spec) |
| 47 |
openAPIVersionedService.RegisterOpenAPIVersionedService("/openapi/v2", mux) |
| 48 |
|
| 49 |
return openAPIVersionedService, spec |
| 50 |
} |
| 51 |
|
| 52 |
// InstallV3 adds the static group/versions defined in the RegisteredWebServices to the OpenAPI v3 spec |
| 53 |
func (oa OpenAPI) InstallV3(c *restful.Container, mux *mux.PathRecorderMux) *handler3.OpenAPIService { |
| 54 |
openAPIVersionedService := handler3.NewOpenAPIService() |
| 55 |
err := openAPIVersionedService.RegisterOpenAPIV3VersionedService("/openapi/v3", mux) |
| 56 |
if err != nil { |
| 57 |
klog.Fatalf("Failed to register versioned open api spec for root: %v", err) |
| 58 |
} |
| 59 |
|
| 60 |
grouped := make(map[string][]*restful.WebService) |
| 61 |
|
| 62 |
for _, t := range c.RegisteredWebServices() { |
| 63 |
// Strip the "/" prefix from the name |
| 64 |
gvName := t.RootPath()[1:] |
| 65 |
grouped[gvName] = []*restful.WebService{t} |
| 66 |
} |
| 67 |
|
| 68 |
for gv, ws := range grouped { |
| 69 |
spec, err := builder3.BuildOpenAPISpecFromRoutes(restfuladapter.AdaptWebServices(ws), oa.V3Config) |
| 70 |
if err != nil { |
| 71 |
klog.Errorf("Failed to build OpenAPI v3 for group %s, %q", gv, err) |
| 72 |
|
| 73 |
} |
| 74 |
openAPIVersionedService.UpdateGroupVersion(gv, spec) |
| 75 |
} |
| 76 |
return openAPIVersionedService |
| 77 |
} |