github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/tequilapi/endpoints/docs.go (about)

     1  /*
     2   * Copyright (C) 2020 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package endpoints
    19  
    20  import (
    21  	"net/http"
    22  
    23  	"github.com/gin-gonic/gin"
    24  	"github.com/mysteriumnetwork/node/tequilapi/endpoints/assets"
    25  )
    26  
    27  // NewDocsEndpoint creates and returns documentation endpoint.
    28  func NewDocsEndpoint() *DocsEndpoint {
    29  	return &DocsEndpoint{}
    30  }
    31  
    32  // DocsEndpoint serves API documentation.
    33  type DocsEndpoint struct{}
    34  
    35  // Index redirects root route to swagger docs.
    36  func (se *DocsEndpoint) Index(c *gin.Context) {
    37  	c.Redirect(http.StatusMovedPermanently, "/docs")
    38  }
    39  
    40  // AddRoutesForDocs attaches documentation endpoints to router.
    41  func AddRoutesForDocs(c *gin.Engine) error {
    42  	endpoint := NewDocsEndpoint()
    43  	c.GET("/", endpoint.Index)
    44  	c.StaticFS("/docs", assets.DocsAssets)
    45  	return nil
    46  }