json to graphql schema: json2graphql

json2graphql

json2graphql 是一個根據 json 生成 GraphQL Schema 的工具。
可在 https://luojilab.github.io/js... 在線體驗其功能。

關於 GraphQL

GraphQL 是一個用於 API 的查詢語言，是一個使用基於類型系統來執行查詢的服務端運行時（類型系統由你的數據定義）。GraphQL 並無和任何特定數據庫或者存儲引擎綁定，而是依靠你現有的代碼和數據支撐。因爲其強類型，返回結果可定製，自帶聚合功能等特性，由 facebook 開源後，被 github 等各大廠普遍使用。

核心概念：

• Type
• Field
• Query/Mutation
• Arguments
• Input
• Variables
• Aliases

更多請參考 https://graphql.cn/

爲何選用 GraphQL

相比 REST API, GraphQL 提供了更高的靈活性。接口調用方可以精確的定義其所需數據，並通知服務方只返回這部分數據，該功能是 REST API 沒法提供的。GraphQL 可以使客戶端只進行一次接口調用，便可獲取多個 REST API 請求返回的數據。這種數據聚合的能力，正是咱們所須要的。

json protobuf 與 GraphQL

因爲 protobuf 和 GraphQL 都是強類型的，因此能夠直接從 protobuf 的 schema 生成 GraphQL Schema,於是纔能有自動聚合 grpc 服務生成 GraphQL 接口的框架 rejoiner。但一樣的方法不適用於 json，由於標準的 json 並不包含 schema,單純根據 json 文件沒法肯定知道每一個字段的類型（由於有空值，以及嵌套的狀況)。於是目前沒法實現相似 rejoiner for json 這樣的全自動框架。
咱們雖不能生成最終的 GraphQL Schema,可是基於對 json 的解析和一些約定，咱們能夠生成一個 GraphQL Schema 的草稿，生成 Schema 的絕大部份內容，並將有疑問的地方標記出來。
json2graphql 就是一個用 golang 實現的 json 生成 schema 的工具。若是你不熟悉 golang,可使用其在線版本 https://luojilab.github.io/js...

在從 REST API 遷移到 GraphQL 的過程當中，咱們有不少接口會返回大量字段（幾十個），若是徹底手動編寫這些 Schema，將是很是痛苦的，咱們開發 json2graphql 的初衷就是解決這個問題，大大縮短開發時間。

如下介紹該工具用法。

Usage

go run main.go -h

NAME:
   inspect - generate a graphql schema based on json

USAGE:
   main [global options] command [command options] [arguments...]

DESCRIPTION:
   inspect json and generate draft schema.graphql

COMMANDS:
     inspect  generate a graphql schema based on json
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --verbose, -v             show logs
   --input value, -i value   the json filename
   --output value, -o value  the target filename to store generated schema
   --help, -h                show help

Example

go run main.go -i example.json

Live Demo

https://luojilab.github.io/js...

TODO

• [x] build it as a web service that render schema on the fly like json.cn
• [ ] support to read from multi json files.
• [ ] get input from http request rather than local file.
• [ ] integrate with graphql server frameworks like gqlgen and auto generate resolver