C# 零基础搭建一个简单的Asp.Net Core WebAip服务
一、创建Asp.Net Core WebApi
1、创建一个新的Asp.Net Core WebApi 项目
启动vs2022,在开始页面选择 “创建新项目(N)”。
选择从C#的asp.net core WebApi 作为一个初始的WebApi模板。
点击下一步,给项目一个项目名称,并且选择我们要存放项目的目录。
点击下一步,选择项目的目标框架,vs2022已经对.NET 6.0 长期支持了,如果你是vs2019或者其他版本,你也可以选择.NET 5.0 或者.NET Core,最后点击创建。
创建好的项目我们可以看到主要有程序依赖包文件(后续需要用到的第三方文件包)、控制器代码文件夹(代码放在这里面)、配置文件(项目基本配置信息)、程序入口文件(也就是所谓的Main函数)组成
2、尝试启动Asp.Net Core WebApi 项目
点击启动键,以Debug的方式启动项目
第一次启动会有ssl证书提示,直接点击是就行
启动后浏览器打开的是接口文档生成工具页面Swagger和一个控制台页面。
swagger显示我们当前的接口:WeatherForecast
控制台运行的是其实是项目编译后生成的 WebApi.exe程序
二、自定义一个API接口
1、添加一个控制器
在控制器 Controllers 文件夹下右键 > 添加 > 控制器添加一个空的控制器:
给控制器起一个名字:TestController.cs
2、编写一个登录接口:Login
AdminController.cs控制器的代码如下:
using Microsoft.AspNetCore.Mvc; namespace WebApi.Controllers { [Route("api/[controller]/[action]")] public class TestController : Controller { [HttpGet] public string Login(string pwd) { if(pwd == "123456") { return "登录成功!"; } return "登录失败"; } } }
[Route(“api/[controller]/[action]”)] 表示自定义api的地址:/api/控制器名称/j接口名称 ,以当前控制器为例:api/Admin/Login?pwd=123456
[HttpGet]表示请求以Get方式进行
3、appsettings.json配置文件修改端口号
appsettings.json代码如下:
{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft.AspNetCore": "Warning" } }, "AllowedHosts": "*", //配置端口号 "Kestrel": { "Endpoints": { "Https": { "Url": "https://*:5000" }, "Http": { "Url": "http://*:5050" } } } }
上面配置文件修改了默认端口号为5050和5000
4、运行程序,测试自定义api接口
以debug的方式启动程序:
然后在浏览器输入接口地址:https://localhost:5000/api/test/login
可以看到接口已经通了,在没有传pwd参数的时候,接口返回:登录失败
我们传一个正确的pwd参数试一下:https://localhost:5000/api/admin/login?PWD=123456
接口返回:登录成功!至此一个简单的Asp.Net Core WebAip就搭建完成了!
三、把 WebAip 发布到服务器上
1、通过文件系统发布到服务器
点击项目右键 > 生成
然后右键点击项目 > 在文件资源管理器打开文件夹,找到生成好的文件系统
把文件夹下的文件全部复制到服务器上,然后再当前文件夹下通过cmd运行MyWebApi.exe
如果运行时出现如上报错,提示系统必须要安装.net 6 的运行框架
用浏览器打开提示给的下载链接:下载 ASP.NET Core 6.0 Runtime (v6.0.11) – Windows x64 Installerz
下载好安装后继续运行MyWebApi.exe ,正常情况下webapi就正常运行起来了
2、通过Docker发布(建议使用!)
虽然.NET core实现了跨平台开发部署,但是如果通过文件系统发布到一个新的服务器上,还是要下载配置.net相关的运行框架,对于新手来说还是比较困难,所以建议使用docker方式直接生成docker镜像,通过服务器端拉取镜像,运行镜像容器就可以实现直接运行webapi程序。