Go言語 – echo

メソッド　URI（リクエストの対象）　ブラウザがサポートしているHTTPのバージョン
ヘッダ部（付加情報）
　（空行）
リクエストボディ部

{
  "users": [
    {
      "user_name": "user1",
      "age": 10
    },
    {
      "user_name": "user2",
      "age": 20
    }
  ]
}

HTTPのバージョン　ステータスコード　理由
ヘッダ部（付加情報）
　（空行）
ボディ部

// go install github.com/labstack/echo/{version}
go install github.com/labstack/echo/v4

// echo型
type Echo struct {
  ・・・
  middleware []MiddlewareFunc
  router *Router
  Server *http.Server
  Validator Validator
  Logger Logger
  ・・・
}

// インスタンス作成
echo.New() (e *Echo)

// 作成したインスタンスにハンドラを登録し、ルーティング設定
func (e *Echo) Get(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

// サーバーを起動し、指定されたアドレスへのリクエストの待ち受けを開始
func (e *Echo) Start(address string) error

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  // ステータスコードと文字列を返す
  String(code int, s string) error
  ・・・
}

package main

import (
  "net/http"
	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.GET("/", func(c echo.Context) error {
    return c.String(http.StatusOK, "Hello, World!")
  })

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

go run main.go

curl -X GET http://localhost:80

Hello, World!

// echo型のルーティング設定のメソッド
type echo
func (e *Echo) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

func main() {
  // インスタンス作成
  e := echo.New()

  // HTTPメソッド(URL, ハンドラの関数)  
  e.POST("/users", CreateUser)
  e.GET("/users/:id", GetUser)
  e.PUT("/users/:id", UpdateUser)
  e.DELETE("/users/:id", DeleteUser)
}


func CreateUser(c echo.Context) errot {・・・}
func GetUser(c echo.Context) errot {・・・}
func UpdateUser(c echo.Context) errot {・・・}
func DeleteUser(c echo.Context) errot {・・・}

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  func Param(name string) string
  ・・・
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.GET("/user/:id", handler.GetUser)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package main

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// パスパラメータを受け取って返す
func GetUser(c echo.Context) error {

  // パスパラメータを受け取る
	id := c.Param("id")

	return c.String(http.StatusOK, id)
}

go run main.go

curl -X GET http://localhost:80/users/100

"100"

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  func QueryParam(name string) string
  ・・・
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.GET("/users, handler.GetUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package main

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// クエリパラメータを受け取って返す
func GetUsers(c echo.Context) error {

	sort := c.QueryParam("sort")
	limit := c.QueryParam("limit")

	res := map[string]interface{}{
		"sort":  sort,
		"limit": limit,
	}

	return c.JSON(http.StatusOK, res)
}

go run main.go

curl -X GET http://localhost:80/users\?sort\=true\&limit\=1000

{
  "limit":"1000",
  "sort":"true"
}

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  func Request() *http.Request
  ・・・
}

// net/httpパッケージのHeaderインターフェース
type Request
type Request interface {
  ・・・
  Header Header
  ・・・
}

// Header型と埋め込んだメソッド
type Header map[string][]string
func (h Header) Get(key string) string

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.PUT("/users/:id", handler.UpdateUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package main

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// ヘッダーのコンテンツタイプを受け取って返す
func UpdateUsers(c echo.Context) error {
	return c.String(http.StatusOK, c.Request().Header.Get("Content-Type"))
}

go run main.go

curl -X PUT -H "Content-Type: application/json" "http://localhost:80/users/1" -d '{"name": "Osamu","age": 20}'

application/json

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  func Bind(i interface{}) error
  ・・・
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.GET("/users, handler.GetUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package request

type GetUsers struct {
	limit int  `query:"limit"`
	sort  bool `query:"sort"`
}

package main

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// クエリパラメータを受け取って返す
func GetUsers(c echo.Context) error {

	u := request.GetUsers{}
	if err := c.Bind(&u); err != nil {
		err = errors.Wrap(err, "failed to bind request data.")
	}

	return c.JSON(http.StatusOK, res)
}

go run main.go

curl -X GET http://localhost:80/users\?sort\=true\&limit\=1000

{
  "limit":"1000",
  "sort":"true"
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
	e.PUT("/users/:id", handler.UpdateUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package request

type UpdateUsers struct {
	ID int `param:"id"`
	Name string `json:"name"`
	Age int `json:"age"`
}

package handler

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// リクエストボディを受け取って返す

func UpdateUsers(c echo.Context) error {

	u := request.UpdateUsers{}
	if err := c.Bind(&u); err != nil {
		err = errors.Wrap(err, "failed to bind request data.")
	}

	return c.JSON(http.StatusOK, u)
}

go run main.go

curl -X PUT -H "Content-Type: application/json" "http://localhost:80/users/1" -d '{"name": "Osamu","age": 20}'

{
  "ID":1,
  "name":"Osamu",
  "age":20
}

go install github.com/go-playground/validator/v10

// バリデート型
type Validate struct {
	// contains filtered or unexported fields
}

// バリデートインスタンス作成
func New() *Validate

// バリデート型のカスタムバリデーションを登録するメソッド
func (v *Validate) RegisterValidation(tag string, fn Func, callValidationEvenIfNull ...bool) error

// バリデート型の構造体のバリデートをするメソッド
func (v *Validate) Struct(s interface{}) error

// カスタムバリデーションのインターフェース
type CustomTypeFunc func(field reflect.Value) interface{}

// 構造体のフィールドをバリデートするためのメソッドを持ったFieldLevel型のインターフェース
type FieldLevel
type FieldLevel interface {
  ・・・
  Field() reflect.Value
  ・・・
}

// コンテキストインターフェース
type Context
type Context interface {
  ・・・
  Validate(i interface{}) error
  ・・・
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // インスタンスにバリデーションを設定
	e.Validator = handler.NewValidator()

  // ルーティング設定
  e.GET("/users, handler.GetUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package handler

import (
  "github.com/go-playground/validator/v10"
  "github.com/labstack/echo/v4"
)

// カスタムバリデーターの構造体
type CustomValidator struct {
  validator *validator.Validate
}

// カスタムバリデーションの登録とインスタンス作成
func NewValidator() echo.Validator {
  validator := validator.New()

  return &CustomValidator{validator: validator}
}

// バリデーション関数
func (cv *CustomValidator) Validate(i interface{}) error {
  return cv.validator.Struct(i)
}

package request

type GetUsers struct {
  Limit int `query:"limit" validate:"required,max=100` // バリデーション設定
  Sort bool `query:"sort" validate:"required"` // バリデーション設定
}

package response

import (
	"reflect"
)

var (
	ErrBadRequest = 1
)

type Error struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

type ErrorResponse struct {
	Status int `json:"status"`
	Error  Error
}

func NewErrorResponse(httpStatus int, errCode int, errMeasage interface{}) ErrorResponse {
	return ErrorResponse{
		Status: httpStatus,
		Error: Error{
			Message: getString(errMeasage),
			Code:    errCode,
		},
	}
}

func getString(i interface{}) string {
	switch v := i.(type) {
	case error:
		return v.Error()
	default:
		return reflect.ValueOf(v).String()
	}
}

package handler

import (
  "net/http"

  "github.com/labstack/echo/v4"
)

// クエリパラメータを受け取って返す
func GetUsers(c echo.Context) error {
  u := request.GetUsers{}
  if err := c.Bind(&u); err != nil {
    err = errors.Wrap(err, "failed to bind request data.")
    return c.JSON(http.StatusBadRequest, response.NewErrorResponse(http.StatusBadRequest, response.ErrBadRequest, err))
	}

	if err := c.Validate(u); err != nil {
    err = errors.Wrap(err, "invalid condition parameter.")
    return c.JSON(http.StatusBadRequest, response.NewErrorResponse(http.StatusBadRequest, response.ErrBadRequest, err))
	}

  return c.JSON(http.StatusOK, u)
}

go run main.go

curl -X GET http://localhost:80/users

{
  "status": 400,
  "Error": {
    "message": "invalid condition parameter.: Key: 'GetUsers.Limit' Error:Field validation for 'Limit' failed on the 'required' tag\nKey: 'GetUsers.Sort' Error:Field validation for 'Sort' failed on the 'required' tag",
    "code": 1
  }
}

curl -X GET http://localhost:80/users\?sort\=true\&limit\=1000

{
  "status":400,
  "Error":{
    "message":"invalid condition parameter.: Key: 'GetUsers.Limit' Error:Field validation for 'Limit' failed on the 'max' tag",
    "code":1
  }
}

curl -X GET http://localhost:80/users\?sort\=true\&limit\=100

{
  "Limit":100,
  "Sort":true
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // インスタンスにバリデーションを設定
	e.Validator = handler.NewValidator()

  // ルーティング設定
  e.GET("/users, handler.GetUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package handler

import (
  "github.com/go-playground/validator/v10"
  "github.com/labstack/echo/v4"
)

// カスタムバリデーターの構造体
type CustomValidator struct {
  validator *validator.Validate
}

// カスタムバリデーションの登録とインスタンス作成
func NewValidator() echo.Validator {
  validator := validator.New()

  // カスタムバリデーションの登録
  _ = validator.RegisterValidation("hoge", IsHoge)

  return &CustomValidator{validator: validator}
}

// バリデーション関数
func (cv *CustomValidator) Validate(i interface{}) error {
  return cv.validator.Struct(i)
}

// カスタムバリデーション
func IsHoge(fl validator.FieldLevel) bool {
	return fl.Field().String() == "hoge"
}

package request

type GetUsers struct {
  Limit int  `query:"limit" validate:"required,max=100` // バリデーション設定
  Sort  bool `query:"sort" validate:"required,hoge"` // バリデーション設定
}

package response

import (
	"reflect"
)

var (
	ErrBadRequest = 1
)

type Error struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

type ErrorResponse struct {
	Status int `json:"status"`
	Error  Error
}

func NewErrorResponse(httpStatus int, errCode int, errMeasage interface{}) ErrorResponse {
	return ErrorResponse{
		Status: httpStatus,
		Error: Error{
			Message: getString(errMeasage),
			Code:    errCode,
		},
	}
}

func getString(i interface{}) string {
	switch v := i.(type) {
	case error:
		return v.Error()
	default:
		return reflect.ValueOf(v).String()
	}
}

package handler

import (
  "net/http"

  "github.com/labstack/echo/v4"
)

// クエリパラメータを受け取って返す
func GetUsers(c echo.Context) error {
  u := request.GetUsers{}
  if err := c.Bind(&u); err != nil {
    err = errors.Wrap(err, "failed to bind request data.")
    return c.JSON(http.StatusBadRequest, response.NewErrorResponse(http.StatusBadRequest, response.ErrBadRequest, err))
	}

	if err := c.Validate(u); err != nil {
    err = errors.Wrap(err, "invalid condition parameter.")
    return c.JSON(http.StatusBadRequest, response.NewErrorResponse(http.StatusBadRequest, response.ErrBadRequest, err))
	}

  return c.JSON(http.StatusOK, u)
}

go run main.go

curl -X GET http://localhost:80/users\?sort\=true\&limit\=100

{
  "status": 400,
  "Error": {
    "message": "invalid condition parameter.: Key: 'GetUsers.Sort' Error:Field validation for 'Sort' failed on the 'hoge' tag",
    "code": 1
	}
}

// echo型のミドルウェアを登録するメソッド
type Echo
func (e *Echo) Use(middleware ...MiddlewareFunc)

// ミドルウェアのインターフェース
type MiddlewareFunc func(next HandlerFunc) HandlerFunc

package middleware

import (
	"github.com/labstack/echo/v4"
	"github.com/rs/xid"
)

func CreateRequestID() echo.MiddlewareFunc {

	return func(next echo.HandlerFunc) echo.HandlerFunc {

    return func(c echo.Context) error {

    // HTTPリクエスト毎に一意のデータを生成
    xid := xid.New().String()

    // コンテキストに指定したキーで生成したデータをセット
    c.Set("requestID", xid)

    // 次のミドルウェアを実行
    return next(c)
    }
	}
}

package main

import (
	"github.com/github-name/repository-name/app/handler"	
	"github.com/github-name/repository-name/app/middleware"	
  "github.com/labstack/echo/v4"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ミドルウェアを登録
	e.Use(middleware.CreateRequestID())

  // ルーティング設定
  e.GET("/users, handler.GetUsers)

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}

package main

import (
	"net/http"

	"github.com/labstack/echo/v4"
)

// 生成したIDを受け取って返す
func GetUsers(c echo.Context) error {
	return c.String(http.StatusOK, request_id := c.Get("requestID"))
}

go run main.go

curl -X GET http://localhost:80/users\?sort\=true\&limit\=1000

c9m7v80ba4ft2i7qft10

// echo型のミドルウェアを登録するメソッド
type Echo
func (e *Echo) Use(middleware ...MiddlewareFunc)

// CORS設定をするための構造体
type CORSConfig struct {
  ・・・
  AllowOrigins []string `yaml:"allow_origins"`
  AllowMethods []string `yaml:"allow_methods"`
  ・・・
}

// CORSの設定を登録するメソッド
func CORSWithConfig(config CORSConfig) echo.MiddlewareFunc

package main

import (
	"github.com/github-name/repository-name/app/handler"	
  "github.com/labstack/echo/v4"
  "github.com/labstack/echo/v4/middleware"
)

func main() {
  // インスタンス作成
  e := echo.New()

  // ルーティング設定
  e.GET("/", func(c echo.Context) error {
		return c.String(http.StatusOK, "Hello, World!")
	})

  // CORSの設定
  e.Use(middleware.CORSWithConfig(middleware.CORSConfig{
    AllowOrigins: []string{"https://example.com"},
    AllowMethods: []string{http.MethodGet, http.MethodHead, http.MethodPut, http.MethodPatch, http.MethodPost, http.MethodDelete},
  }))

  // サーバー起動
  e.Logger.Fatal(e.Start(":80"))
}