使用Visual Studio Code创建WebApi

目录

  1、  检查开发环境

  2、  创建新的WebApi

  3、  启动项目

  4、  生成并测试API

  5、  初步认识

  6、  Models

  7、  Services

  8、  Controllers 

  9、  生成并测试Controllers 

10、  CRUD操作

11、  生成并运行WebApi（CRUD）

1、检查开发环境

新建一个文件夹，在Visual Srudio Code打开， 并在终端输入：dotnet --list-sdks

检查是否是.NET6.0以上版本的SDK

如不是请自行前往官网安装 Download .NET (Linux, macOS, and Windows)

其次检查Visual Srudio Code是否安装好C#扩展

2、 创建新的WebApi

在终端输入：dotnet new webapi -f net6.0

此时右下角会弹出“C#扩展”的提示框，直接选择yes

会自动配置好launch.json文件和tasks.json文件

3、启动项目

终端输入：dotnet run

也可以直接按F5

此时会得到两个HTTPS链接

此时点击打开链接是得不到页面的

请记住此时您的的端口号（PORT）后续都是需要用到的

这里小编是浏览器上URL中localhost :后的7282

同时编辑上一步浏览器中的URL：https://localhost:7282/weatherforecast 

并按下回车，会得到一串JSON

 4、生成并测试API

此时回到Visual Studio Code，打开一个新的终端

并输入：dotnet tool install -g Microsoft.dotnet-httprepl

目的是为安装.NET HTTP REPL的命令行工具，用于向Web Api发送请求的。

输入命令链接WebApi：httprepl https://localhost:{PORT}

注：这里的PORT是上文标注要记住的端口号

查看可用的终结点，终端输入：ls

转到WeatherForecast

发送get请求，得到一连串的JSON

结束当前的HttpRepl 会话，exit

 5、初步认识

ApiController API控制器，应用于特定控制器

Route 路由

ControllerBase 基类

具体描述等待小编后续，或者您可以自行前往微软官网进行查阅

6、Models

添加Models文件夹

在Models文件夹中新建Pizza.cs

给Pizza.cs添加一些数据，如图

注：项目文件命名一定要规范，切勿学小编的错误命名！

 7、Services

添加Services文件夹

在Services文件夹中新建PizzaServices.cs

给PizzaServices.cs添加以下代码，如图

最后生成一下项目，终端输入 “dotnet build”

8、Controllers 

Controllers 文件夹下添加名为 PizzaController.cs 的新文件，并编写如下代码

9、生成并测试Controllers 

终端启动项目 ：dotnet run 

链接WebApi ：httprepl https://localhost:{PORT}

查看终结点 ：ls

转到终结点Prizza ： cd Pizza

发送get请求 ： get

也可以根据id查询，即 “get id”，如

具体操作步骤与上文 “生成并测试API” 一致，此处不多做赘述。

10、CRUD操作

CRUD就是增加(Create)、读取查询(Retrieve)、更新(Update)和删除(Delete)几个单词的首字母简写，俗称“增删改查”。

（查部分上文已阐述，接下来增删改）

打开PizzaController.cs ，添加如下代码

11、生成并运行WebApi（CRUD）

终端启动项目：  dotnet run 

链接WebApi ： httprepl https://localhost:{PORT}

查看终结点：  ls

转到终结点Prizza ： cd Pizza

（步骤与上文一致，不多做赘述）

发送POST请求，在 HttpRepl 中添加新的内容

终端输入：post -c "{"name":"TestName", "isGlutenFree":false}"

使用以下命令发出 PUT 请求，修改name的值为“NewName”

终端输入：put 3 -c  "{"id": 3, "name":" NewName ", "isGlutenFree":false}"

delete删除操作

终端输入：delete 3

本章到此结束，感谢各位观看

如若不懂各位也可以移步到微软官方教程

参考微软官网教程