github.com/m3db/m3@v1.5.0/src/query/api/v1/handler/openapi/openapi.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package openapi
    22  
    23  import (
    24  	"net/http"
    25  
    26  	"github.com/m3db/m3/src/query/api/v1/route"
    27  	assets "github.com/m3db/m3/src/query/generated/assets/openapi"
    28  	"github.com/m3db/m3/src/query/util/logging"
    29  	"github.com/m3db/m3/src/x/instrument"
    30  	xhttp "github.com/m3db/m3/src/x/net/http"
    31  
    32  	"go.uber.org/zap"
    33  )
    34  
    35  const (
    36  	// URL is the url for the OpenAPI handler.
    37  	URL = route.Prefix + "/openapi"
    38  
    39  	// HTTPMethod is the HTTP method used with this resource.
    40  	HTTPMethod = http.MethodGet
    41  
    42  	docPath = "/index.html"
    43  )
    44  
    45  var (
    46  	// StaticURLPrefix is the url prefix for openapi specs.
    47  	StaticURLPrefix = URL + "/static/"
    48  )
    49  
    50  // DocHandler handles serving the OpenAPI doc.
    51  type DocHandler struct {
    52  	instrumentOpts instrument.Options
    53  }
    54  
    55  // NewDocHandler returns a new doc handler.
    56  func NewDocHandler(
    57  	instrumentOpts instrument.Options,
    58  ) http.Handler {
    59  	return &DocHandler{
    60  		instrumentOpts: instrumentOpts,
    61  	}
    62  }
    63  
    64  // ServeHTTP serves the OpenAPI doc.
    65  func (h *DocHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    66  	ctx := r.Context()
    67  	logger := logging.WithContext(ctx, h.instrumentOpts)
    68  
    69  	doc, err := assets.FSByte(false, docPath)
    70  
    71  	if err != nil {
    72  		logger.Error("unable to load doc", zap.Error(err))
    73  		xhttp.WriteError(w, err)
    74  		return
    75  	}
    76  
    77  	w.Header().Set(xhttp.HeaderContentType, xhttp.ContentTypeHTMLUTF8)
    78  	w.Write(doc)
    79  }
    80  
    81  // StaticHandler is the handler for serving static assets (including OpenAPI specs).
    82  func StaticHandler() http.Handler {
    83  	return http.StripPrefix(StaticURLPrefix, http.FileServer(assets.FS(false)))
    84  }