.Net Core WebApi的简单创建以及使用方法-6ren

.Net Core WebApi的简单创建以及使用方法

转载作者：qq735679552 更新时间：2022-09-29 22:32:09

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章.Net Core WebApi的简单创建以及使用方法由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

前言。

按照目前的软件开发发展趋势中，不管是前后端分离还是提供数据服务，WebApi使用的越来越广泛，而且.NET Core也是我们.NET开发人员未来发展的趋势，所以说学会使用.NET Core Api是非常有必要的.

本人作为一个.NET菜鸟，正在慢慢的学习中，将学到的一步一步记录下来.

1、创建项目。

打开VS2019，新建一个ASP.NET Core Web 应用程序.

.Net Core WebApi的简单创建以及使用方法

输入项目名、选择路径创建.

.Net Core WebApi的简单创建以及使用方法

选择.NET Core 我这里用的是.NET Core 2.2版本，选中API，把右边的选中取消.

.Net Core WebApi的简单创建以及使用方法

创建的项目目录内容如下.

.Net Core WebApi的简单创建以及使用方法

2、编辑控制器。

打开Controllers文件夹，这里我直接使用默认创建的ValuesController控制器。（其实是因为这是个例子我懒的再建了(￣.￣)）。

.Net Core WebApi的简单创建以及使用方法

ValuesController控制器默认内容如下。共有四个HTTP方法，分别为 Get、Post、Put 和 Delete.

.Net Core WebApi的简单创建以及使用方法

把该控制器的内容重新写一下，将路由设置为api/控制器/方法（api/[controller]/[action]）。按照常用Get 和 Post两个请求，写了两个Get方法和一个Post方法，一个参数类.

using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;using Microsoft.AspNetCore.Mvc;namespace FirstApi.Controllers{  //路由设置  [Route("api/[controller]/[action]")]  [ApiController]  public class ValuesController : ControllerBase  {    /// <summary>    /// 获取文本    /// </summary>    /// <returns></returns>    [HttpGet]    public ActionResult<string> Get()    {      return "Hello World!";    }    /// <summary>    /// 两数相加    /// </summary>    /// <param name="num1">第一个数</param>    /// <param name="num2">第二个数</param>    /// <returns></returns>    [HttpGet]    public ActionResult<int> Sum(int num1,int num2)    {      return num1 + num2;    }    /// <summary>    /// 两数相减    /// </summary>    /// <param name="param">参数</param>    /// <returns></returns>    [HttpPost]    public ActionResult<int> Subtract(Param param)    {      int result = param.num1 - param.num2;      return result;    }  }  /// <summary>  /// 参数  /// </summary>  public class Param  {    /// <summary>    /// 第一个数    /// </summary>    public int num1 { get; set; }    /// <summary>    /// 第二个数    /// </summary>    public int num2 { get; set; }  }}

然后右键项目→属性→调试，将启动浏览器默认指向为第一个Get方法.

.Net Core WebApi的简单创建以及使用方法

调试运行，访问第一个方法，返回结果.

.Net Core WebApi的简单创建以及使用方法

访问第二个方法加上参数，得到结果.

.Net Core WebApi的简单创建以及使用方法

第三个方法是Post请求，无法直接输入，可以用其他方式实现.

3、搭建Swagger 。

这样WebApi 就简单实现了，不过这样不容易管理。为了更好的管理和测试我们的接口，我这里使用了Swagger框架.

Swagger是什么？Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 Web 服务.

右键项目，点击管理NuGet程序包.

.Net Core WebApi的简单创建以及使用方法

切换到浏览，搜索“Swashbuckle.AspNetCore”，安装.

.Net Core WebApi的简单创建以及使用方法

安装完成之后，编辑Startup.cs文件.

.Net Core WebApi的简单创建以及使用方法

引用下面三个命名空间.

using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;using Microsoft.AspNetCore.Mvc;namespace FirstApi.Controllers{  //路由设置  [Route("api/[controller]/[action]")]  [ApiController]  public class ValuesController : ControllerBase  {    /// <summary>    /// 获取文本    /// </summary>    /// <returns></returns>    [HttpGet]    public ActionResult<string> Get()    {      return "Hello World!";    }    /// <summary>    /// 两数相加    /// </summary>    /// <param name="num1">第一个数</param>    /// <param name="num2">第二个数</param>    /// <returns></returns>    [HttpGet]    public ActionResult<int> Sum(int num1,int num2)    {      return num1 + num2;    }    /// <summary>    /// 两数相减    /// </summary>    /// <param name="param">参数</param>    /// <returns></returns>    [HttpPost]    public ActionResult<int> Subtract(Param param)    {      int result = param.num1 - param.num2;      return result;    }  }  /// <summary>  /// 参数  /// </summary>  public class Param  {    /// <summary>    /// 第一个数    /// </summary>    public int num1 { get; set; }    /// <summary>    /// 第二个数    /// </summary>    public int num2 { get; set; }  }}

在ConfigureServices方法里加入下面的代码，注册Swagger生成器，定义一个文档，设置xml文档的注释路径，.

//配置Swagger//注册Swagger生成器，定义一个Swagger 文档services.AddSwaggerGen(c =>{  c.SwaggerDoc("v1", new Info  {    Version = "v1",    Title = "接口文档",    Description = "RESTful API"  });  // 为 Swagger 设置xml文档注释路径  var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";  var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);  c.IncludeXmlComments(xmlPath);});

在Configure方法里加入下面的代码，启用中间件服务使用生成Swagger和SwaggerUI，将SwaggerUI中的RoutePrefix设为空字符串，这样就能在根节点（http://localhost:port）直接显示SwaggerUI界面.

//启用中间件服务生成Swaggerapp.UseSwagger();//启用中间件服务生成SwaggerUI，指定Swagger JSON终结点app.UseSwaggerUI(c =>{  c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");  c.RoutePrefix = string.Empty;//设置根节点访问});

编辑后Startup.cs完整代码如下.

using System;using System.Collections.Generic;using System.IO;using System.Linq;using System.Reflection;using System.Threading.Tasks;using Microsoft.AspNetCore.Builder;using Microsoft.AspNetCore.Hosting;using Microsoft.AspNetCore.Mvc;using Microsoft.Extensions.Configuration;using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Logging;using Microsoft.Extensions.Options;using Swashbuckle.AspNetCore.Swagger;namespace FirstApi{  public class Startup  {    public Startup(IConfiguration configuration)    {      Configuration = configuration;    }    public IConfiguration Configuration { get; }    // This method gets called by the runtime. Use this method to add services to the container.    public void ConfigureServices(IServiceCollection services)    {      services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);      //配置Swagger      //注册Swagger生成器，定义一个Swagger 文档      services.AddSwaggerGen(c =>      {        c.SwaggerDoc("v1", new Info        {          Version = "v1",          Title = "接口文档",          Description = "RESTful API"        });        // 为 Swagger 设置xml文档注释路径        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);        c.IncludeXmlComments(xmlPath);      });    }    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.    public void Configure(IApplicationBuilder app, IHostingEnvironment env)    {      if (env.IsDevelopment())      {        app.UseDeveloperExceptionPage();      }      //启用中间件服务生成Swagger      app.UseSwagger();      //启用中间件服务生成Swagger，指定Swagger JSON终结点      app.UseSwaggerUI(c =>      {        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");        c.RoutePrefix = string.Empty;//设置根节点访问      });      app.UseMvc();    }  }}

然后，右键项目，点击属性.

.Net Core WebApi的简单创建以及使用方法

选择生成，选择我们的Debug路径.

.Net Core WebApi的简单创建以及使用方法

勾选XML文档文件，自动填充，然后会出现警告（非强迫症可以忽略警告）。

.Net Core WebApi的简单创建以及使用方法

想要去掉警告，就在上面的取消显示警告中加入上面显示的1591，Ctrl+S保存一下，警告就没了.

.Net Core WebApi的简单创建以及使用方法

然后点击调试，将启动浏览器后面url去掉.

.Net Core WebApi的简单创建以及使用方法

完成后，直接运行VS，就会进入文档UI页面了.

.Net Core WebApi的简单创建以及使用方法

4、使用Swagger 。

我们打开第一个方法，点击Try it out按钮.

.Net Core WebApi的简单创建以及使用方法

这个是无参的方法，直接点击Execute执行.

.Net Core WebApi的简单创建以及使用方法

执行后可以看到Response body返回的内容.

.Net Core WebApi的简单创建以及使用方法

点击第二个方法，给出两个参数，输入执行，得到返回结果.

.Net Core WebApi的简单创建以及使用方法

第三个方法的参数是model，要传递json格式的，默认已经生成好了，我们只需要编辑改一下值，再执行就行了.

.Net Core WebApi的简单创建以及使用方法

5、总结。

到这里.NET Core Api的简单搭建和使用就告一段落了，此篇学到了如何创建.NET Core Api项目与怎么搭建Swagger生成文档及使用，接下来我会继续学习和运用.NET Core Api，并将其过程记录下来。本来想在这篇标题加个（一），但是想了想最近有可能更不了，等以后更了再加上吧.

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对的支持.

最后此篇关于.Net Core WebApi的简单创建以及使用方法的文章就讲到这里了,如果你想了解更多关于.Net Core WebApi的简单创建以及使用方法的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！。

文章推荐：利用.net core实现反向代理中间件的方法

文章推荐： .NET Core 实现微信小程序支付功能（统一下单）

文章推荐： ASP.NET Core 3.0迁移的完美避坑指南

文章推荐： Win10 IIS 安装.net 4.5的方法

javascript - 使用 WebScriptEndpoint 使用 javascript 使用 WCF 服务
我在网上搜索但没有找到任何合适的文章解释如何使用 javascript 使用 WCF 服务，尤其是 WebScriptEndpoint。任何人都可以对此给出任何指导吗？谢谢最佳答案这是一篇关于
c - 没有结果!!使用 fork() 使用 dup2 使用 2 个管道运行 execlp()
我正在编写一个将运行 Linux 命令的 C 程序，例如: cat/etc/passwd | grep 列表 |剪切-c 1-5 我没有任何结果 *这里 parent 等待第一个 child (chi
python - 处理文件上传，使用 Pillow 调整大小，使用 SQLAlchemy 存储，使用 Flask 提供文件
所以我正在尝试处理文件上传，然后将该文件作为二进制文件存储到数据库中。在我存储它之后，我尝试在给定的 URL 上提供文件。我似乎找不到适合这里的方法。我需要使用数据库，因为我使用 Google 应用引
excel - 使用 IF 使用 VBA 在单元格中添加公式的问题
我正在尝试制作一个宏，将下面的公式添加到单元格中，然后将其拖到整个列中并在 H 列中复制相同的公式我想在 F 和 H 列中输入公式的数据 Range("F1").formula = "=IF(ISE
使用 OperatorPrecedenceParser 使用 FParsec 解析函数应用程序？
问题类似于this one ，但我想使用 OperatorPrecedenceParser 解析带有函数应用程序的表达式在 FParsec . 这是我的 AST: type Expression =
sql - 使用 sequelize 使用 where 查询编码计数
我想通过使用 sequelize 和 node.js 将这个查询更改为代码取决于在哪里 select COUNT(gender) as genderCount from customers where
bash - 使用 “let”分配Bash失败，使用 “/”
我正在使用GNU bash，版本5.0.3(1)-发行版(x86_64-pc-linux-gnu)，我想知道为什么简单的赋值语句会出现语法错误: #/bin/bash var1=/tmp
javascript - 使用 JavaScript 使用 FOR OF 数组循环时出现错误？
这里，为什么我的代码在 IE 中不起作用。我的代码适用于所有浏览器。没有问题。但是当我在 IE 上运行我的项目时，它发现错误。而且我的 jquery 类和 insertadjacentHTMl 也不
javascript - 使用 javascript 使用 for 属性更改表单标签内容
我正在尝试更改标签的innerHTML。我无权访问该表单，因此无法编辑 HTML。标签具有的唯一标识符是“for”属性。这是输入和标签的结构:
javascript - 使用 jquery 使用 .on() 将事件附加到页面上的动态插入按钮
我有一个页面，我可以在其中返回用户帖子，可以使用一些 jquery 代码对这些帖子进行即时评论，在发布新评论后，我在帖子下插入新评论以及删除按钮。问题是 Delete 按钮在新插入的元素上不起作用，
使用 awk 使用 sha1sum 进行散列
我有一个大约有 20 列的“管道分隔”文件。我只想使用 sha1sum 散列第一列，它是一个数字，如帐号，并按原样返回其余列。使用 awk 或 sed 执行此操作的最佳方法是什么？ Accounti
mysql - 使用 insert into 使用 mysql
我需要将以下内容插入到我的表中...我的用户表有五列 id、用户名、密码、名称、条目。 (我还没有提交任何东西到条目中，我稍后会使用 php 来做)但由于某种原因我不断收到这个错误:#1054 - U
jquery - 将输入字段值修剪为仅字母数字字符/使用 .使用 jQuery
所以我试图有一个输入字段，我可以在其中输入任何字符，但然后将输入的值小写，删除任何非字母数字字符，留下“。”而不是空格。例如，如果我输入: 地球的 70% 是水，-!*#$^^ & 30% 土地输
javascript - 使用 .innerHTML 使用 DOM
我正在尝试做一些我认为非常简单的事情，但出于某种原因我没有得到想要的结果？我是 javascript 的新手，但对 java 有经验，所以我相信我没有使用某种正确的规则。这是一个获取输入值、检查选择
php - 使用 angularjs 使用 where 子句从数据库获取数据
我想使用 angularjs 从 mysql 数据库加载数据。这就是应用程序的工作原理；用户登录，他们的用户名存储在 cookie 中。该用户名显示在主页上我想获取这个值并通过 angularjs
ios - 使用 UITableViewCell 使用 AutoLayout
我正在使用 autoLayout，我想在 UITableViewCell 上放置一个 UIlabel，它应该始终位于单元格的右侧和右侧的中心。这就是我想要实现的目标所以在这里你可以看到我正在谈论的
mysql - 使用 ElasticSearch 使用 or 和运算符搜索多个字段
我需要与 MySql 等效的 elasticsearch 查询。我的 sql 查询: SELECT DISTINCT t.product_id AS id FROM tbl_sup_price t
ios - 使用 Swift 使用 JSON
我正在实现代码以使用 JSON。 func setup() { if let flickrURL = NSURL(string: "https://api.flickr.com/
javascript - 使用 JavaScript 使用 for 循环声明变量
我尝试使用for循环声明变量，然后测试cols和rols是否相同。如果是，它将运行递归函数。但是，我在 javascript 中执行 do 时遇到问题。有人可以帮忙吗？现在，在比较 col.1 和
jquery - 使用 :after 使用 jquery 更改样式
我举了一个我正在处理的问题的简短示例。 HTML代码: 1 2 3 CSS 代码: .BB a:hover{ color: #000; } .BB > li:after {

qq735679552

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

.Net Core WebApi的简单创建以及使用方法