的简单创建和使用网络核心网络应用编程接口

时间：2021-08-20 来源：互联网编辑：宝哥软件园浏览：次

前言

从目前软件开发的发展趋势来看，无论是分离前端和后端还是提供数据服务，WebApi的应用越来越广泛，而且。NET Core也是我们未来的发展趋势。NET开发人员，所以学习使用是非常必要的。NET核心Api。

作为一个. NET菜鸟，我在慢慢学习，我会一步一步记录我所学的东西。

首先，创建一个项目

打开VS2019，创建一个新的ASP.NET核心网络应用程序。

输入项目名称并选择要创建的路径。

选择。NET核心。我用。net core版本在这里，选择API，取消右边的选择。

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

第二，编辑控制器

打开控制器文件夹，在那里我直接使用默认创建的值控制器。(其实因为这是个例子，我也懒得再建了(.))

值控制器默认如下。HTTP方法有四种，分别是获取、发布、放入和删除。

重写控制器的内容，并将路由设置为API/controller/method(API/[controller]/[action])。根据常用的Get和Post请求，编写了两个Get方法、一个Post方法和一个参数类。

使用系统；使用系统。集合。通用；使用系统。Linq使用系统。线程化。任务；使用微软。AspNetCore . Mvc命名空间第一API。controllers {//route setting[route(' API/[controller]/[action]')][API controller]公共类值controller : controller base {///Summary///Get text///Summary///returns/returns[http Get]public actionresultstring Get(){ return ' hello world！'；}///summary///summary//param name=' num 1 '第一个数字/param ///param name='num2 '第二个数字/param///returns/returns[http get]公共操作结果sum (int num1，int num2) } ///summary ///减去两个数字/////summary///param name=' param '参数/param///returns/returns[http post]公共操作结果减法(param){ int result=param . num-param。返回结果；} }///summary///parameter////summary public class param {///summary////第一个数字/////summary public int num 1 { get；设置；}///summary///second number////summary public int num 2 { get；设置；}}}然后右击项目属性调试，浏览器默认的启动点是第一个Get方法。

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

访问第二个方法并添加参数以获得结果。

第三种方法是Post请求，不能直接输入，可以通过其他方式实现。

第三，打造霸气

这使得WebApi实现起来很简单，但管理起来并不容易。为了更好地管理和测试我们的界面，我在这里使用了Swagger框架。

什么是斯瓦格？Swagger是一个标准和完整的框架，用于生成、描述、调用和可视化RESTful风格的网络服务。

右键单击项目，然后单击管理获取包。

切换到浏览，搜索“Swashbuckle。AspNetCore”，并安装它。

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

引用以下三个命名空间。

使用系统；使用系统。集合。通用；使用系统Linq .使用系统。线程化。任务；使用微软AspNetCore。手动音量调节命名空间第一个Api .控制器{ //路由设置[路由(' API/[控制器]/[动作])][API控制器]公共类值控制器：控制器基础{///summary///获取文本////summary////returns/returns[HttpGet]public ActionResultstring Get(){ return ' Hello World！'；} ///摘要///两数相加////summary////param name=' num 1 '第一个数/param ///param name='num2 '第二个数/param///returns/returns[HttpGet]public ActionResultint Sum(int num 1，int num 2){ return num 1 num 2；} ///摘要///两数相减////summary ///param name='param '参数/Param///returns/returns[Httpset]public ActionResultint核减(参数参数){ int result=Param。数字1-参数。num 2；返回结果；} } ///摘要///参数////摘要公共类Param { ///摘要///第一个数////summary public int num 1 { get；设置；} ///摘要///第二个数////summary public int num 2 { get；设置；} }}在配置服务方法里加入下面的代码，注册时髦的生成器，定义一个文档，设置可扩展标记语言文档的注释路径，

//配置霸气//注册时髦的生成器，定义一个时髦的文档服务AddSwaggerGen(c={ c . SwaggerDoc(' v1)，新信息{版本='v1 '，标题='接口文档，Description=' RESTful API ' })；//为时髦的设置可扩展标记语言文档注释路径var xmlFile=$'{Assembly .GetExecutingAssembly().GetName().名称}。XML '；var xmlPath=路径。组合(AppContext .BaseDirectory，xmlFile)；c . includexcmments(XMlpath)；});在安装使成形方法里加入下面的代码，启用中间件服务使用生成时髦的和SwaggerUI，将SwaggerUI中的RoutePrefix设为空字符串，这样就能在根节点(http://localhost:port)直接显示SwaggerUI界面。

//启用中间件服务生成赃物useswaggle()；//启用中间件服务生成SwaggerUI，指定斯瓦格数据终结点应用程序.UseSwaggerUI(c={ c . SwaggerEndpoint('/swag/v1/swag。JSON '，' V1网络应用'；c.RoutePrefix=字符串。空的；//设置根节点访问});编辑后Startup.cs完整代码如下。

使用系统；使用系统。集合。通用；使用系统IO；使用系统Linq .使用系统。反思；使用系统。线程化。任务；使用微软AspNetCore。建设者使用微软。托管；使用微软AspNetCore。手动音量调节使用微软。扩展。配置；使用微软。扩展。依赖注射；使用微软。扩展。日志记录；使用微软。扩展。选项；使用Swashbuckle .AspNetCore。时髦的命名空间第一个API {公共类启动{公共启动(图标配置)}配置){配置=配置}公共图标配置{ get} //此方法由运行时调用。使用此方法向容器添加服务public void ConfigureServices(IServiceCollection services){ services .AddMvc().SetCompatibilityVersion(兼容性版本. version _ 2 _ 2)；//配置霸气//注册时髦的生成器，定义一个时髦的文档服务AddSwaggerGen(c={ c . SwaggerDoc(' v1)，新信息{版本='v1 '，标题='接口文档，Description=' RESTful API ' })；//为时髦的设置可扩展标记语言文档注释路径var xmlFile=$'{Assembly .GetExecutingAssembly().GetName().名称}。XML '；var xmlPath=路径。组合(AppContext .BaseDirectory，xmlFile)；c . includexcmments(XMlpath)；});} //运行时调用此方法。使用此方法配置超文本传送协议请求管道公共空间配置(IApplicationBuilder)应用程序，ihostingenvirmentenv){ if(env .IsDevelopment()) { app .usedeveloper异常页()；} //启用中间件服务生成霸气应用useswaggle()；//启用中间件服务生成霸气，指定斯瓦格数据终结点应用程序.UseSwaggerUI(c={ c . SwaggerEndpoint('/swag/v1/swag。JSON '，' V1网络应用'；c.RoutePrefix=字符串。空的；//设置根节点访问});应用程序.UseMvc()；} }}然后，右键项目，点击属性。