Go言語でのRest APIの実装

Question

ご閲覧いただきありがとうございます。

##やりたいこと

Go言語で、標準パッケージのみでRest APIを実装出来るようになりたいです。
しかし、ネットにある情報ではGorilla muxを使ったものばかりで参考になりません。

##やってみたこと

自分でも以下のように実装してみたのですが、これだとgorilla muxを使っていないのでHTTPリクエストメソッドと自前で用意したメソッドを関連づけられません。

package main

import (
	"fmt"
	"net/http"
)

func homePage(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "home page hit")
}

func main() {
	// handleRequest()
	http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) {
		fmt.Fprintf(w, "Hello,") //Gorilla muxを使えば、ここに .Methods("GET")というようにHTTPメソッドを紐づけられる
	  })
	  http.ListenAndServe(":8080", nil)
}

Gorilla muxを使った実装はこちらです。これでやりたいことは実現できているのですが、標準パッケージのみで出来るようになりたいです。

package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"

	"github.com/gorilla/mux"
)

func homeLink(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "Welcome home!")
}

func main() {
	router := mux.NewRouter().StrictSlash(true)
    router.HandleFunc("/", homeLink)
	router.HandleFunc("/events", getAllEvents).Methods("GET")
	router.HandleFunc("/events/{id}", getOneEvent).Methods("GET")

	http.ListenAndServe(":8080", router)
}

type event struct {
	ID          string `json:"ID"`
	Title       string `json:"Title"`
	Description string `json:"Description"`
}

type allEvents []event

var events = allEvents{
	{
		ID:          "11",
		Title:       "Introduction to Golang",
		Description: "Come join us for a chance to learn how golang works and get to eventually try it out",
	},
}

func getOneEvent(w http.ResponseWriter, r *http.Request) {
	eventID := mux.Vars(r)["id"]

	for _, singleEvent := range events {
		if singleEvent.ID == eventID {
			json.NewEncoder(w).Encode(singleEvent)
		}
	}
}

func getAllEvents(w http.ResponseWriter, r *http.Request) {
	json.NewEncoder(w).Encode(events)
}

もしお分かりになる方がいましたら、どうかお力をお貸しください。よろしくお願いいたします。

Answer 1

要約するとルーターを標準パッケージでどうつくるかという質問ですね。

提示された例の程度であればほとんど標準のルーターで十分にまかなえます。

func main() {
	mux := http.NewServeMux()
	mux.HandleFunc("/", homeLink)
	mux.HandleFunc("/events", getAllEvents)
	mux.Handle("/events/", http.StripPrefix("/events/", http.HandlerFunc(getOneEvent)))

	http.ListenAndServe(":8080", mux)
}

{id}を取り出す部分は以下のコードで取り出せます。

func getOneEvent(w http.ResponseWriter, r *http.Request) {
	eventID := r.URL.Path
	...
}

ポイントは予めhttp.StripPrefixでURLの先頭を削っておいたところですね。

goではhttpハンドリングに使える型に以下の2種類があります。

• 「Handler」型（ServeHTTPメソッドをもつ）
• 「func (w http.ResponseWriter, r *http.Request)」関数型

「func (w http.ResponseWriter, r *http.Request)」関数型は
HandlerFunc型にキャストすればHandlerとコンパチになることを覚えておくと良いでしょう。

いろんなミドルウェアはHandlerをラップしてHandlerを形成するパターンが多いので
Handler互換であればいろんなミドルウェアが使えます。
そのひとつが「http.StripPrefix」です。

Comments

[nobonobo]

同様にGET以外のメソッドをエラーにするミドルウェアを書いてハンドラをラップしておくと完全に互換のコードになりますので挑戦してみてください。

[nobonobo]

gorillaのmuxの「.Methods("GET")」というのは別に紐づけるとかではなく、Methodsに指定したメソッド以外をhttp.StatusMethodNotAllowedステータスを返すということです。
そのような処理をハンドラ側に書いてもいいし、ミドルウェアでそのような処理を挟んでもいいわけです。
やれる方法で書いてみていただけたらアドバイスします。

[nobonobo]

http.RequestにはMethodというフィールドがあります。そこをチェックするだけなので頑張ってみましょう。

[anonyrabbit]

丁寧なご回答ありがとうございます。自分のやり方を記入致しますので、アドバイスいただけると非常にありがたいです。

Answer 2

上記回答例のように振り分け用にハンドラを一つ挟むやり方は最もオススメです。
応用が一番効くので。GETだけに反応させたければ以下のように書きましょう。
もちろんGETとPOSTそれぞれに違う処理を入れるのはアリです。

func handleTrustRequest(w http.ResponseWriter, r *http.Request) {
    switch r.Method {
    case "GET":
        handleTrustGet(w, r)
    default:
        http.Error(w, r.Method + " method not allowed", http.StatusMethodNotAllowed)
    }
}

エラーを上記のように書いた場合、クライアントに届けるエラーのコンテンツがテキストになります。
JSONである必要があればContent-Typeにapplication/jsonを指定してから
JSONを文字列に変換したものを返すなどしましょう。

で、ミドルウェア方式は以下のように書きます。

func GetOnly(next http.Handler) http.Handler {
  return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    if r.Method != "GET" {
        http.Error(w, r.Method + " method not allowed", http.StatusMethodNotAllowed)
    }
    next.ServeHTTP(w, r)
  })
}

func main() {
    http.Handle("/trust", GetOnly(http.HandlerFunc(handleTrustGet)))
}

上記の例だとじゃぁPOSTの対応を増やすには？というと結局分岐を挟まないといけなくなって、
ミドルウェアの体裁で分岐を書くのはちょっと骨が折れます。なので質問者さんの回答の書き方を
基本に書いておくと良いと思います。（標準だけでMethod別に振り分けする方法としてはベストじゃないかと）

Comments

[anonyrabbit]

丁寧なご回答ありがとうございます。コードを確認していただけて、サンプルコードまで提示していただけて、とても助かりました。ありがとうございました。

[anonyrabbit]

それと、あと一つだけ教えていただきたいのですが、なぜ二つ目のコードはミドルウェア方式になるのでしょうか？
ミドルウェアとは、「オペレーションシステム(OS)」と「アプリケーションソフト」の中間に入るソフトウェアのことだと思うのですが、2つ目のどこにコードにミドルウェア要素があるのかが分かりません・・・。
参考になるリンクだけ提示していただくのでも良いので、簡単に教えていただけると助かります。

[nobonobo]

それはもう少し狭い意味の「ミドルウェア」ですね。
https://www.alexedwards.net/blog/making-and-using-middleware
このあたりなどで使われる「ミドルウェア」はPythonのデコレータのように呼び出しの間に差し込む小さな実装も含んでいます。

[anonyrabbit]

なるほど、それは知りませんでした。ありがとうございます。覚えておきます。

Answer 3

nobonobo様

ここではベタ書きしたJSON形式の構造体のデータを使っていますが、一応リソースとURIを対応づけていますし、HTTPリクエストメソッドを通して内部処理をしているので、これだけでRest APIになっていると言えると思うのですが、いかがでしょうか？改善のためアドバイス頂けますと幸いです。

func main() {

	http.HandleFunc("/trust", handleTrustRequest
	http.HandleFunc("/belief", handleBeliefRequest)
    http.ListenAndServe(":8080", nil)
}

func handleTrustRequest(w http.ResponseWriter, r *http.Request) {
	switch r.Method {
	case "GET":
		handleTrustGet(w, r)
	case "POST":
		
	}
}

type trust struct {
	ID string `json:"ID"`
	Title string `json:"Title"`
	Description string `json:"Description"`
}

type allTrusts []trust

var trusts = allTrusts{
	{
		ID:          "11",
		Title:       "trust",
		Description: "Come join us for a chance to learn how golang works and get to eventually try it out",
	},
}

func handleTrustGet(w http.ResponseWriter, r *http.Request) {
	json.NewEncoder(w).Encode(trusts)
}