一種用于 API 的查詢語言
GraphQL 既是一種用于 API 的查詢語言也是一個(gè)滿足你數(shù)據(jù)查詢的運(yùn)行時(shí)亮蒋。 GraphQL 對(duì)你的 API 中的數(shù)據(jù)提供了一套易于理解的完整描述乘粒，使得客戶端能夠準(zhǔn)確地獲得它需要的數(shù)據(jù)翻诉，而且沒有任何冗余匀借，也讓 API 更容易地隨著時(shí)間推移而演進(jìn)，還能用于構(gòu)建強(qiáng)大的開發(fā)者工具偎漫。
根據(jù)請(qǐng)求得到你想要的數(shù)據(jù)
最重要的是得到不多不少溅固、正正好的數(shù)據(jù)。
向你的 API 發(fā)出一個(gè) GraphQL 請(qǐng)求就能準(zhǔn)確獲得你想要的數(shù)據(jù)晾剖，不多不少锉矢。 GraphQL 查詢總是返回可預(yù)測的結(jié)果。使用 GraphQL 的應(yīng)用可以工作得又快又穩(wěn)齿尽，因?yàn)榭刂茢?shù)據(jù)的是應(yīng)用沈撞，而不是服務(wù)器。
這篇博客我們就主要就講講根據(jù)請(qǐng)求獲取不多不少的數(shù)據(jù)雕什，這也是GraphQL最大的優(yōu)點(diǎn)之一缠俺。
GraphQL來源
GraphQL是由Facebook開源的；
具體實(shí)現(xiàn)
由于最近在弄一個(gè)開源項(xiàng)目Email-Dashboard,
里面也會(huì)用到GraphQL來實(shí)現(xiàn)API查詢贷岸，這里實(shí)現(xiàn)語言就采用golang壹士，該項(xiàng)目里面就用的是golang。
golang GraphQL官方庫
GraphQL結(jié)合http實(shí)現(xiàn)Handler
main.go具體實(shí)現(xiàn)：
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
"github.com/graphql-go/graphql"
"github.com/graphql-go/handler"
gqlhandler "github.com/graphql-go/handler"
)
type Comment struct {
ID int `json:"id"`
Author string `json:"author"`
Body string `json:"body"`
PostID int `json:"postId"`
}
func main() {
runGin()
}
//使用http實(shí)現(xiàn)GraphQL
func runHTTP() {
rootQuery := graphql.ObjectConfig{
Name: "Query",
Fields: graphql.Fields{
"comment": &graphql.Field{
Type: CreateType(),
Args: graphql.FieldConfigArgument{
"id": &graphql.ArgumentConfig{
Type: graphql.NewNonNull(graphql.Int),
},
},
Resolve: func(p graphql.ResolveParams) (interface{}, error) {
id := p.Args["id"]
v, _ := id.(int)
return &Comment{ID: v, Author: "aa", Body: "bb", PostID: 2}, nil
},
},
}}
schema, err := graphql.NewSchema(graphql.SchemaConfig{
Query: graphql.NewObject(rootQuery),
})
if err != nil {
panic(err)
}
graphqlHandler := gqlhandler.New(&gqlhandler.Config{
Schema: &schema,
})
graphiqlHandler := gqlhandler.New(&gqlhandler.Config{
Schema: &schema,
Pretty: true,
GraphiQL: false,
Playground: true,
})
http.Handle("/graphql", graphqlHandler)
http.Handle("/graphiql", graphiqlHandler)
fmt.Println(http.ListenAndServe(":8080", nil))
}
//使用gin實(shí)現(xiàn)GraphQL
func runGin() {
router := gin.Default()
router.GET("/", func(c *gin.Context) {
c.String(http.StatusOK, fmt.Sprintf("Hello from GraphQL API!"))
})
api := router.Group("/api/v3")
//核心入口
rootQuery := graphql.ObjectConfig{
Name: "Query",
Fields: graphql.Fields{
//要請(qǐng)求的元素
"comment": &graphql.Field{
//該元素里面的元素類型聲明
Type: CreateType(),
//query參數(shù)聲明
Args: graphql.FieldConfigArgument{
"id": &graphql.ArgumentConfig{
Type: graphql.NewNonNull(graphql.Int),
},
},
Resolve: func(p graphql.ResolveParams) (interface{}, error) {
//具體參數(shù)獲取
id := p.Args["id"]
v, _ := id.(int)
//數(shù)據(jù)返回
return &Comment{ID: v, Author: "aa", Body: "bb", PostID: 2}, nil
},
},
}}
schema, err := graphql.NewSchema(graphql.SchemaConfig{
Query: graphql.NewObject(rootQuery),
})
if err != nil {
panic(err)
}
api.POST("/graphql", GraphqlHandler(schema))
api.GET("/graphql", GraphqlHandler(schema))
router.Run(":8080")
}
func CreateType() *graphql.Object {
return graphql.NewObject(graphql.ObjectConfig{
Name: "Comment",
Fields: graphql.Fields{
"id": &graphql.Field{
Type: graphql.NewNonNull(graphql.Int),
},
"author": &graphql.Field{
Type: graphql.String,
},
"body": &graphql.Field{
Type: graphql.String,
},
"postId": &graphql.Field{
Type: graphql.NewNonNull(graphql.Int),
},
},
})
}
//為GraphQL handler 結(jié)合gin封裝的func
func GraphqlHandler(schema graphql.Schema) gin.HandlerFunc {
h := handler.New(&handler.Config{
Schema: &schema,
})
return func(c *gin.Context) {
h.ServeHTTP(c.Writer, c.Request)
}
}
go run main.go運(yùn)行上面的實(shí)例偿警，即可發(fā)布GraphQL接口
結(jié)果展示
gin通過http://localhost:8080/api/v3/graphql訪問躏救；
http通過http://localhost:8080/graphql訪問；
如圖片中帶上具體的query參數(shù)即可螟蒸；
如上圖片中盒使，如果你只需要id和author，則你的query參數(shù)就設(shè)置成{comment(id:1){id,author}}七嫌；
這樣就只會(huì)給你返回id和author的json串少办。
這樣也就是返回不多不少，剛剛好的數(shù)據(jù)诵原。
后續(xù)
第一篇GraphQL的入門介紹就到這了英妓；
GraphQL的介紹也會(huì)持續(xù)更新，有問題可以在下面留言绍赛。
