github.com/erda-project/erda-infra@v1.0.9/providers/legacy/httpendpoints/interface.go (about)

     1  // Copyright (c) 2021 Terminus, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package httpendpoints
    16  
    17  import (
    18  	"context"
    19  	"net/http"
    20  
    21  	"github.com/erda-project/erda-infra/providers/legacy/httpendpoints/i18n"
    22  	"github.com/gorilla/mux"
    23  )
    24  
    25  // Endpoint contains URL path and corresponding handler
    26  type Endpoint struct {
    27  	Path           string
    28  	Method         string
    29  	Handler        func(context.Context, *http.Request, map[string]string) (Responser, error)
    30  	WriterHandler  func(context.Context, http.ResponseWriter, *http.Request, map[string]string) error
    31  	ReverseHandler func(context.Context, *http.Request, map[string]string) error
    32  }
    33  
    34  // Interface .
    35  type Interface interface {
    36  	RegisterEndpoints(endpoints []Endpoint)
    37  	Router() *mux.Router
    38  }
    39  
    40  // Responser is an interface for http response
    41  type Responser interface {
    42  	GetLocaledResp(locale i18n.LocaleResource) HTTPResponse
    43  	GetStatus() int
    44  	GetContent() interface{}
    45  }