1.2 .net 8 ASP.NET Core Web API 项目创建之 Hello,World

这篇具有很好参考价值的文章主要介绍了1.2 .net 8 ASP.NET Core Web API 项目创建之 Hello,World。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、概述

上一节演示了如何创建一个新的Web API 项目,并展示了如何运行及测试接口,这节的主要目标是增加一个hello的接口,接口返回内容为“Hello,World!”,在添加接口之前,我们先要对上一节的项目进行分析,只有了解项目的结构,才能知道怎么去添加新的接口和扩展新的功能。
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

二、项目分析

1、代码文件结构

为了便于介绍,我把项目结构进行了完全展开,如下图
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

2、展开介绍

(1)、Properties - launchSettings.json*

这个文件只有在开发环境下才有用,它用于配置程序在开发环境中用的端口号及启动方式。
打开文件,我们可以看到定义了两种启动方式
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net
可以通过菜单栏上选择不同的启动方式,可以看到,launchSettings.json文件里面的两种启动方式,在下拉框中存在。
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

(2)、依赖项

主要是项目的一些依赖包或框架,可以看到,里面默认已经帮我们引入了一些基础包和框架,后续一些第三方的依赖包也是在这里引入依赖和管理,先了解即可。
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

(3)、Controllers

接口定义一般都是放在这个目录下,可以看到,里面包含了一个WeatherForecastController的文件,类标注了[ApiController]属性,表示这是一个API 类型的Controller,里面有一个Get请求的接口(在Controller中,[HttpGet]属性表示这是一个Get请求的接口,同理,如果是[HttpPost]则表示是Post请求的接口)
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net
我们之前调试的接口就是它
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

(4)、appsettings.json

项目的配置文件,一些常见的配置信息可以写到里面,注意是Json格式

(5)、MyStudyAPI.Web.Host.http

便于接口调试的一个文件,可以通过这个文件进行接口调式,也比较方便,不想用也可以删掉
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

(6)、Program.cs

项目的入口启动文件,里面内容先不展开,后续章节再深入分析下。

(7)、WeatherForecast

默认演示项目的返回实体定义

三、添加Hello,World

项目接口分析完,再次回到本节的主要目标:增加一个hello的接口,接口返回内容为“Hello,World!”

我们参照默认代码(WeatherForecast)的示例,开始依葫芦画瓢,非常简单

(1)增加HelloController.cs文件

在Controllers目录下,新建一个HelloController.cs的类
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net
新建完成后,可以在目录下看到
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

(2)、修改HelloController.cs文件

修改后的代码如下

[ApiController]
[Route("[controller]")]
public class HelloController : ControllerBase
{
    [HttpGet(Name = "GetHello")]
    public string Get()
    {
        return "Hello,World!";
    }
}

(3)、运行项目

运行项目后,可以看到,我们的Hello接口出现了
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net
测试一下:
.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net

可以到看到返回值为"Hello,World!",成功!

总结

本节的目标我们已经完成了,由于我们完全是仿照示例代码的写法,可能大家会有 一些疑问,比如:
在接口前面,我们明明写了接口名称为,[HttpGet(Name = “GetHello”)],为什么接口最终名称却是Hello,Hello的名字究竟怎么来的?和Name = "GetHello"到底有没有关系,我们可以试下:比如改成Greeting,[HttpGet(Name = “GetGreeting”)],看看有无变化?

代码

[ApiController]
[Route("[controller]")]
public class HelloController : ControllerBase
{
    [HttpGet(Name = "GetGreeting")]
    public string Get()
    {
        return "Hello,World!";
    }
}

.net8 core api,.net 8 web api 教程,从0开始,前端,.net,asp.net
可以看到,依旧还是Hello的名字,那么Hello的名字究竟怎么来的?
还有我们如果想把接口改成其他的名称,应该怎么做呢?
还有我们继承ControllerBase,以及[Route(“[controller]”)]属性,又是分别起到什么作用呢?
留下这几个问题,我们下节继续。

敬请期待…文章来源地址https://www.toymoban.com/news/detail-806562.html

到了这里,关于1.2 .net 8 ASP.NET Core Web API 项目创建之 Hello,World的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • ASP.Net Core Web API结合Entity Framework Core框架(API的创建使用,接口前端权限设置,前端获取API的Get,post方法)(程序包引用以及导入数据库)

    目录 1. Web Api 程序包引用 2. Web Api 的创建与Http类型的介绍 2.1 ASP.Net Core Web API项目的创建 2 .2  API接口的创建 2.3 HttpGet和HttpPost类型的区别 3.接口权限设置 4.HttpGet方法和HttpPOst方法 5.前端中用HttpGet/Poset获取接口数据 6.EF框架——配置数据库链接字符串(即将数据库中的表导入项

    2024年02月08日
    浏览(49)
  • 2.1 .net 8 ASP.NET Core Web API - Controller详解

    书接上回,上节我们留了几个问题,即: 1、接口Hello的名字究竟怎么来的? 2、我们如果想把接口改成其他的名称,应该怎么做? 3、我们继承ControllerBase,以及[Route(“[controller]”)]属性,又是分别起到什么作用? 需要解决以上几个问题,我们就要继续深入研究Controller相关的

    2024年02月20日
    浏览(33)
  • ASP.NET Core Web API用户身份验证

    ASP.NET Core Web API用户身份验证的方法有很多,本文只介绍JWT方法。JWT实现了服务端无状态,在分布式服务、会话一致性、单点登录等方面凸显优势,不占用服务端资源。简单来说,JWT的验证过程如下所示: (1)通过用户名和密码获取一个Token。 (2)访问API时,加上这个Toke

    2024年02月11日
    浏览(34)
  • ASP.NET Core 中的两种 Web API

    ASP.NET Core 有两种创建 RESTful Web API 的方式: 基于 Controller,使用完整的基于ControllerBase的基类定义接口endpoints。 基于 Minimal APIs,使用Lambda表达式定义接口 endpoints。 基于 Controller 的 Web API 可以使用构造函数注入,或者属性注入,遵循面向对象模式。 基于 Minimal APIs 的 Web API 通

    2024年02月09日
    浏览(31)
  • ASP.NET Core Web API之Token验证

    在实际开发中,我们经常需要对外提供接口以便客户获取数据,由于数据属于私密信息,并不能随意供其他人访问,所以就需要验证客户身份。那么如何才能验证客户的什么呢?今天以一个简单的小例子,简述ASP.NET Core Web API开发过程中,常用的一种JWT身份验证方式。仅供学

    2024年02月11日
    浏览(32)
  • ASP.NET Core Web API 流式返回,逐字显示

    Websocket、SSE(Server-Sent Events)和长轮询(Long Polling)都是用于网页和服务端通信的技术。 Websocket是一种全双工通信协议,能够实现客户端和服务端之间的实时通信。它基于TCP协议,并且允许服务器主动向客户端推送数据,同时也允许客户端向服务器发送数据。 SSE是一种单向

    2023年04月23日
    浏览(38)
  • ASP.NET Core Web API入门之三:使用EF Core

    一般来讲我们做项目都会用实体类跟数据库实体进行关系对应,这样的好处方便我们维护、增删改查,并且可以减少SQL的编写,从而统一风格,那么 Entity Framework Core 就是很不错的ORM框架。 1、跨数据库支持能力强大,只需修改配置就可以轻松实现数据库切换。 2、提升了开发效

    2024年02月10日
    浏览(39)
  • ASP.NET Core 中基于 Controller 的 Web API

    客户端发送Http请求,Contoller响应请求,并从数据库读取数据,序列化数据,然后通过 Http Response返回序列化的数据。 Web API 的所有controllers 一般继承于 ControllerBase 类,而不是Controller 类。 因为 Controller 类也继承自ControllerBase 类,但是支持views,而API一般不需要这个功能。 Co

    2024年02月10日
    浏览(48)
  • 在 ASP.NET Core Web API 中处理 Patch 请求

    PUT 和 PATCH 方法用于更新现有资源。 它们之间的区别是,PUT 会替换整个资源,而 PATCH 仅指定更改。 在 ASP.NET Core Web API 中,由于 C# 是一种静态语言( dynamic 在此不表),当我们定义了一个类型用于接收 HTTP Patch 请求参数的时候,在 Action 中无法直接从实例中得知客户端提供了哪

    2024年02月04日
    浏览(33)
  • 如何将.NET 8.0的ASP.NET Core Web API部署成Windows服务

    前面写了一篇关于将.NET应用转换成Windows服务的方法,其实真正的目的是为了探索如何将Asp.Net Core Web Api 部署成Windows 服务。基于上一篇的基础,只需把创建 WebApplication 的代码放到 BackgroundService 的ExecuteAsync方法中即可。 其中比较重要的一个细节就是需要指定一下配置:    

    2024年01月17日
    浏览(35)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包