创建一个dotnet API项目

准备工作

• 保证你的开发电脑上安装了dotnet core sdk
  这里使用的是 dotnet core 2.2 的版本
• 选择合适的开发工具
  开发net core 的ide 现在基本上只有 vscode ,jetbrain rider和 visual studio 2019
• 选择API测试工具
  可视化的可以选择 postman,脚本化的选择 curl 或 httpie
  比较推荐 httpie

dotnet CLI 是什么？

创建dotnet应用前，需要首先学习下 cli 的使用方法。
dotnet CLI 是一个命令行接口(Command Line Interface)，用于实现自动化开发工作流程。它允许你做以下这些事情：

• 创建、构建、发布应用
• 添加引用
• 数据库迁移
• 等等

初步搭建一个API项目

这里以一个文件管理的API项目作为示例进行介绍，业务功能基本就是文件的在线查看，上传下载项目，也包含简单的用户登录功能。

• 开始创建项目
  dotnet new webapi -n fileserver

• 添加日志组件
  日志组件是任何一个应用的基础，通过输出的日志开发、运维人员才能了解到系统运行的状况。
  这里并不把日志输出到文件或数据库，而是直接输出到控制台。发布到Docker容器后，输出到控制台的日志会输出到容器中，再可以采用第三方组件收集起来。
  添加相关引用

dotnet add package Microsoft.Extensions.Logging
dotnet add package Serilog.AspNetCore
dotnet add package Serilog.Sinks.Console
dotnet add package Serilog.Settings.Configuration

仅仅是向控制台输出日志其实无需引用 Serilog，微软自带的日志组件足以，但是如果需要格式化的日志输出Serilog还是比较合适，毕竟日志最终还是要看的。
关于serilog可以参考asp.net core 日志组件 serilog

• 引用 swagger
  swagger解决现有程序API文档问题
  在调用其他人编写的Web API时，了解其各种方法对于开发人员来说可能是一项挑战。
  还好Swagger提供一些帮助，比如在dotnet core 中可以通过安装第三方的程序集解决现有API的文档问题，通过一套反射机制从代码中生成文档，并且借助ajax可以直接在文档中对API进行交互。因为代码与文档是捆绑的所以在迭代代码的时候，就能方便的将文档也更新了。不会出现随着项目推移代码与文档不匹配的问题。
  添加引用

dotnet add package Swashbuckle.AspNetCore

比如我的 asp.net core 项目地址：http://localhost:5000，那么就可以访问 http://localhost:5000/swagger就可以进入到API文档控制台。
推荐阅读：API标准规范 - Swagger

• 跨域支持 CORS
  添加引用

dotnet add package Microsoft.AspNetCore.Cors

推荐阅读：第1章 1.3 API 服务 (webapi) 支持跨域访问CORS

• JWT
  在用户验证方面采用jwt格式的登录票据
  添加引用

dotnet add package JWT
dotnet add package Newtonsoft.Json   //顺便就加上吧

推荐阅读：用户验证三部曲3 - JWT

测试项目

虽然到现在为止，还没有创建一个API控制器，但是默认在Controller目录下是有一个自动生成的控制器 ValuesController.cs

namespace fileserver.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        // GET api/values
        [HttpGet]
        public ActionResult> Get()
        {
            return new string[] { "value1", "value2" };
        }
        // GET api/values/5
        [HttpGet("{id}")]
        public ActionResult Get(int id)
        {
            return "value";
        }
        ...
    }
}

运行应用
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 ，就可以查看当前的API文档，在网页上也能测试API。