-
Notifications
You must be signed in to change notification settings - Fork 720
/
swaggerserver.go
51 lines (43 loc) · 1.41 KB
/
swaggerserver.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Copyright 2020 TiKV Project Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build swagger_server
// +build swagger_server
package swaggerserver
import (
"context"
"net/http"
httpSwagger "github.com/swaggo/http-swagger"
_ "github.com/tikv/pd/docs/swagger"
"github.com/tikv/pd/pkg/utils/apiutil"
"github.com/tikv/pd/server"
)
const swaggerPrefix = "/swagger/"
var (
swaggerServiceGroup = apiutil.APIServiceGroup{
Name: "swagger",
Version: "v1",
IsCore: false,
PathPrefix: swaggerPrefix,
}
)
// Enabled return true if swagger server is disabled.
func Enabled() bool {
return true
}
// NewHandler creates a HTTP handler for Swagger.
func NewHandler(context.Context, *server.Server) (http.Handler, apiutil.APIServiceGroup, error) {
swaggerHandler := http.NewServeMux()
swaggerHandler.Handle(swaggerPrefix, httpSwagger.Handler())
return swaggerHandler, swaggerServiceGroup, nil
}