準(zhǔn)備工作
- 保證你的開發(fā)電腦上安裝了dotnet core sdk
這里使用的是 dotnet core 2.2 的版本 - 選擇合適的開發(fā)工具
開發(fā)net core 的ide 現(xiàn)在基本上只有 vscode ,jetbrain rider和 visual studio 2019 - 選擇API測試工具
可視化的可以選擇 postman,腳本化的選擇 curl 或 httpie
比較推薦 httpie
dotnet CLI 是什么？
創(chuàng)建dotnet應(yīng)用前，需要首先學(xué)習(xí)下 cli 的使用方法。
dotnet CLI 是一個(gè)命令行接口(Command Line Interface)，用于實(shí)現(xiàn)自動化開發(fā)工作流程。它允許你做以下這些事情：
- 創(chuàng)建、構(gòu)建、發(fā)布應(yīng)用
- 添加引用
- 數(shù)據(jù)庫遷移
- 等等
初步搭建一個(gè)API項(xiàng)目
這里以一個(gè)文件管理的API項(xiàng)目作為示例進(jìn)行介紹，業(yè)務(wù)功能基本就是文件的在線查看，上傳下載項(xiàng)目，也包含簡單的用戶登錄功能。
開始創(chuàng)建項(xiàng)目
dotnet new webapi -n fileserver添加日志組件
日志組件是任何一個(gè)應(yīng)用的基礎(chǔ)，通過輸出的日志開發(fā)、運(yùn)維人員才能了解到系統(tǒng)運(yùn)行的狀況。
這里并不把日志輸出到文件或數(shù)據(jù)庫，而是直接輸出到控制臺。發(fā)布到Docker容器后，輸出到控制臺的日志會輸出到容器中，再可以采用第三方組件收集起來。
添加相關(guān)引用
dotnet add package Microsoft.Extensions.Logging
dotnet add package Serilog.AspNetCore
dotnet add package Serilog.Sinks.Console
dotnet add package Serilog.Settings.Configuration
僅僅是向控制臺輸出日志其實(shí)無需引用 Serilog，微軟自帶的日志組件足以，但是如果需要格式化的日志輸出Serilog還是比較合適，畢竟日志最終還是要看的。
關(guān)于serilog可以參考asp.net core 日志組件 serilog
- 引用 swagger
swagger解決現(xiàn)有程序API文檔問題
在調(diào)用其他人編寫的Web API時(shí)，了解其各種方法對于開發(fā)人員來說可能是一項(xiàng)挑戰(zhàn)。
還好Swagger提供一些幫助，比如在dotnet core 中可以通過安裝第三方的程序集解決現(xiàn)有API的文檔問題，通過一套反射機(jī)制從代碼中生成文檔，并且借助ajax可以直接在文檔中對API進(jìn)行交互。因?yàn)榇a與文檔是捆綁的所以在迭代代碼的時(shí)候，就能方便的將文檔也更新了。不會出現(xiàn)隨著項(xiàng)目推移代碼與文檔不匹配的問題。
添加引用
dotnet add package Swashbuckle.AspNetCore
比如我的 asp.net core 項(xiàng)目地址：http://localhost:5000，那么就可以訪問 http://localhost:5000/swagger就可以進(jìn)入到API文檔控制臺。
推薦閱讀：API標(biāo)準(zhǔn)規(guī)范 - Swagger
- 跨域支持 CORS
添加引用
dotnet add package Microsoft.AspNetCore.Cors
- JWT
在用戶驗(yàn)證方面采用jwt格式的登錄票據(jù)
添加引用
dotnet add package JWT
dotnet add package Newtonsoft.Json //順便就加上吧
推薦閱讀：用戶驗(yàn)證三部曲3 - JWT
測試項(xiàng)目
雖然到現(xiàn)在為止，還沒有創(chuàng)建一個(gè)API控制器，但是默認(rèn)在Controller目錄下是有一個(gè)自動生成的控制器 ValuesController.cs
namespace fileserver.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
// GET api/values
[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
return new string[] { "value1", "value2" };
}
// GET api/values/5
[HttpGet("{id}")]
public ActionResult<string> Get(int id)
{
return "value";
}
...
}
}
運(yùn)行應(yīng)用
dotnet run
控制臺輸出
dai@Inspiron:~/demo2019/fileserver$ dotnet run
2019-07-12 16:45:31.412 +08:00 [Warning] Microsoft.AspNetCore.DataProtection.KeyManagement.XmlKeyManager
No XML encryptor configured. Key {ce185b1c-5f0b-405a-808d-b36e08de75a3} may be persisted to storage in unencrypted form.
Hosting environment: Development
Content root path: /home/dai/demo2019/fileserver
Now listening on: https://localhost:5001
Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.
由于之前配置過 swagger,使用瀏覽器 訪問http://localhost:5000/swagger ，就可以查看當(dāng)前的API文檔，在網(wǎng)頁上也能測試API。
