Asp.netCore3.0 WebApi从0到1手摸手教你写【1】简单的webapi接口

开发环境

Visual Studio 2019
.net core 3.0

打开vs2019新建项目

具体步骤如下图:


第一步创建新项目

第二步选择ASP.NET Core Web应用程序然后下一步

第三步配置新项目然后点创建

此处我们选择API(新手不推荐选择空项目,选择API系统会为我们自动创建WebApi需要的一些配置文件等),Https配置这一项我们暂时不勾选,目前我们不配置Https。


第四步创建新的ASP.Net Core Web 应用程序

点创建以后的界面如下图:
XXX webapi

运行项目

F5运行项目,然后就可以看到微软为我们写好的一个天气预报示例webapi了,这里只有一个Get请求示例,返回值为json格式。


天气预报webapi示例

Startup.cs说明

注意:services.AddControllers();endpoints.MapControllers(); 方法成对出现, 这是.net core3.0中的最新写法

ConfigureServices方法
用来向容器中注册服务,注册好的服务可以在其他地方进行调用.

Configure方法
用来配置中间件管道,即如何响应http请求.


创建第一个Controller

1 右键删除系统默认创建的WeatherForecastController.csWeatherForecast.cs
2 新建一个控制器,命名:UserController.cs

新建UserController 01

新建UserController 02

新建UserController 03

新建以后如下图:
UserController

注:我们打开项目依赖项,可以看到系统默认给我们增加了EntiyFrameworkCore的引用,由此就可以看出微软也在大力推广EF的使用了。
image.png

回归正题,我们在UserController中增加一个Loginget方式的接口方法,返回一个hello,我们打算通过请求api/User/Login来得到这个hello,F5运行程序

namespace XXX.api.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class UserController : ControllerBase
    {
        [HttpGet]
        public IActionResult Login()
        {
            return Ok("hello");
        }
    }
}

问题来了,为啥直接给打开weatherforecast,而且还404了,别急,往下看。

404了

在项目Properties中打开launchsettings.json
launchsettings.json

修改launchsettings.json,我们删掉了关于IIS相关的内容(让webapi不通过IIS来加载),然后修改了lauchUrl属性,如下:

{
  "profiles": {
    "XXX.api": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "api/User/Login",
      "applicationUrl": "http://localhost:5000/",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

(┬_┬)怎么还是404?别急继续往下看

依然404

因为我们是要通过api/User/Login来得到这个hello,所以我们要在UserController里定义一个action的动作,这样才能通过api/User/Login来得到这个hello,如下图新增action

F5运行结果如下:
运行结果

增加全局路由

上面增加action虽然能达到想要的结果,但是每次新建一个Controller都有写个action万一要是忘记了又要忙乎半天,有没有一劳永逸的办法呢?
继续往下看:
1.首先去掉Controller里的RouteApiController

1

2.修改Startup.cs,增加路由模版:

配置路由

感觉每次还是删除两段代码还是有点麻烦,虽然麻烦,但是用全局路由可以方便后期更改,万一老板不想通过api/xxx/xxx的方式来访问接口,想通过api2/xxx/xxx的方式访问,此时你只需要修改下Startup.cs即可。

今天就到这里,后期继续完善我们的webapi。

项目源码地址

https://github.com/xiaxiaoqian/NetCore3.0-WebApi

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容