GraphQL EP 3:GraphiQL – 測試、查詢並公開API的資訊
What Is GraphiQL
不論使用的是Java Spring Boot或ASP.NET Core開發RESTful API,都有一個超級強大的API測試、查詢與公開API資訊的工具Swagger (官方網站),身為”類”API的GraphQL,也有同樣的需求,所以產生了GraphiQL (GitHub)這個工具,同樣提供測試、查詢與公開資訊的功能!
實作
第1步:在pom.xml加上GraphiQL的依賴套件。
<dependency>
<groupId>com.graphql-java</groupId>
<artifactId>graphiql-spring-boot-starter</artifactId>
<version>5.0.2</version>
</dependency>
完成了,就這麼簡單!
現在執行專案,並打開瀏覽器連線到http(s)://{ip or hostname}:8080/graphiql,即可看到下圖:
從左至右,其功能分別是:
- 左:Query的內容,可以任意的編寫需要的Query
- 中:回傳的內容,伺服器回應Query的內容
- 右:API說明文件,所有關於API的內容都在此
所有功能都與Swagger相似,只是UI佈局不同,對於從RESTful API + Swagger轉過來的開發者而言,可以非常快的上手!
~ END ~