這篇文章主要給大家介紹了關於ASP.NET Core使用GraphQL第一章之Hello World的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨着小編來一起學習學習吧
前言
你是否已經厭倦了REST風格的API? 讓我們來聊一下GraphQL。
下面是GraphQL的定義：
GraphQL 既是一種用於 API 的查詢語言也是一個滿足你數據查詢的運行時。 GraphQL 對你的 API 中的數據提供了一套易於理解的完整描述，使得客戶端能夠準確地獲得它需要的數據，而且沒有任何冗餘，也讓 API 更容易地隨着時間推移而演進，還能用於構建強大的開發者工具。
GraphQL由Facebook開發，始於2012年，2015年公開。
GraphQL牛逼之處是它可以讓客戶端精確的查詢它們想要的，不附加額外的東西，這樣的話就很容易讓客戶端隨着API的演進去使用。
GraphQL提供了一種聲明式的方式從服務器拉取數據。你可以從GraphQL官網中瞭解到GraphQL的所有優點。在這一系列博客中，我將展示如何在ASP.NET Core中集成GraphQL, 並使用GraphQL作爲你的API查詢語言。
使用GraphQL的聲明式查詢，你可以自定義API返回的屬性列表。這與REST API中每個API只返回固定字段不同。
安裝GraphQL
爲了在C#中使用GraphQL, GraphQL社區中提供了一個開源組件 graphql-dotnet 。本系列博客中我們都將使用這個組件。
首先我們創建一個空的ASP.NET Core App
dotnet new web --name chatper1
然後我們添加對 graphql-dotnet 庫的引用
dotnet add package GraphQL
創建第一個Query
下面我們來創建一個 query 類, 我們將它命名爲 HelloWorldQuery 。 graphql-dotnet 中，查詢類都需要繼承 ObjectGraphType 類，所以 HelloWorldQuery 的代碼如下
using GraphQL.Types;
public class HelloWorldQuery : ObjectGraphType
{
public HelloWorldQuery()
{
Field<StringGraphType>(
name: "hello",
resolve: context => "world"
);
}
}
這裏你可能注意到我們使用了一個泛型方法 Field ，並傳遞了一個GraphQL的字符串類型 StringGraphType 來定義了一個 hello 字段, resolve 參數是一個Func委託，在其中定義瞭如何返回當前字段的值，這裏我們是直接返回了一個字符串hello。
查詢類中的返回字段都是定義在查詢類的構造函數中的
現在我們一個有了一個查詢類，下一步我們需要使用這個查詢類構建一個結構(schema)。
在 Startup.cs 文件的 Configure 方法中，使用以下代碼替換原有代碼
var schema = new Schema {
Query = new HelloWorldQuery()
};
app.Run(async (context) =>
{
var result = await new DocumentExecuter()
.ExecuteAsync(doc =>
{
doc.Schema = schema;
doc.Query = @"
query {
hello
}
";
}).ConfigureAwait(false);
var json = new DocumentWriter(indent: true)
.Write(result)
await context.Response.WriteAsync(json);
});
- DocumentExecuter 類的 ExecuteAsync 方法中我們定義Action委託，並通過這個委託設置了一個 ExecutionOptions 對象。這個對象初始化了我們定義的結構(schema), 並執行了我們定義的查詢字符串。
- doc.Query 定義了一個查詢字符串
- 最終查詢執行的結果會通過 DocumentWriter 類實例的 Write 被轉換成一個JSON字符串
下面我們來運行一下這個程序
dotnet run
你將在瀏覽器中看到以下結果
{
"data": {
"hello": "world"
}
}
從以上的例子中，你會發現使用GraphQL並不像想象中那麼難。下面我們可以在 HelloWorldQuery 類的構造函數中再添加一個字段 howdy , 並指定這個字段會返回一個字符串 universe 。
Field<StringGraphType>( name: "howdy", resolve: context => "universe" );
然後我們繼續修改 Startup 類中的 Configure 方法, 修改我們之前定義的query
var schema = new Schema {
Query = new HelloWorldQuery()
};
app.Run(async (context) =>
{
var result = await new DocumentExecuter()
.ExecuteAsync(doc =>
{
doc.Schema = schema;
doc.Query = @"
query {
hello
howdy
}
";
}).ConfigureAwait(false);
var json = new DocumentWriter(indent: true)
.Write(result)
await context.Response.WriteAsync(json);
});
重新啓動項目後，結果如下
{
"data": {
"hello": "world",
"howdy": "universe"
}
}
總結
本篇我們只是接觸了GraphQL的一些皮毛，你可能會對GraphQL聲明式行爲有很多問題，沒有關係，後續博客中，我們慢慢解開GraphQL的面紗。下一篇我們將介紹如何創建一箇中間件(Middleware)
本篇源代碼：https://github.com/lamondlu/GraphQL_Blogs (本地下載)
好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對神馬文庫的支持。