.net core webapi (1) 搭建

以.NET Core为框架,搭建出一个功能完善的WebApi框架。实现后台管理系统、前台系统和App系统的统一管理。

该框架欲集成Swagger作为接口显示文档,集成SqlSugar作为数据库操作ORM,集成LayUI作为后台管理系统前端框架,集成支付宝和微信的SDK实现支付功能;

实现接口权限验证功能,实现从后台管理系统无代码化的自动生成实体类、自动生成基础的增删改查接口、自动生成基础版的后台管理页面;

新建一个ASP.NET Core Web应用程序,取名为RayPI。
新建一个ASP.NET Core Web应用程序,取名为RayPI。
在这里插入图片描述

生成项目之后,控制器默认生成了一个ValuesController,里面只有几个简单的RESTful风格的接口,分别对应增删改查的功能,没有涉及到数据库数据

入调试运行状态,默认调用的是values的获取集合接口

项目里集成swagger

Swagger是一个API接口文档帮助插件,使用它,可以将我们编写的接口自动生成一个规范化的文档,其他开发人员(主要是负责的对接接口的前端人员)就可以通过浏览器访问对应的地址,查看接口的相关信息。

下面开始引入swagger插件

方法有两个:

1)可以去swagger官网或github上下载源码,然后将源码(一个类库)引入自己的项目;

2)直接利用NuGet包添加程序集应用。

因为很少有需要更改swagger源码的需求,所以这里我们选择比较简单的第二种方法。

依次点击 工具=>NuGet包管理器=>管理解决方案的NuGet程序包

在这里插入图片描述

在这里插入图片描述

安装完成之后,在项目的依赖项里可以看到多出了一个引用

这时如果运行调试,在域名后面输入/swagger,会发现wagger还没有起作用,因为还没有在项目的启动项里添加swagger服务。

下面添加服务:

打开Startup.cs类,编辑ConfigureServices类

public void ConfigureServices(IServiceCollection services)
        {
            //services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
            services.AddMvc();

            #region Swagger
            services.AddSwaggerGen(c => {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v4.1.0",
                    Title = "Ray WebAPI",
                    Description = "框架集合",
                    TermsOfService = "None",
                    Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "Blommor", Email = "645302361@qq.com", Url = "https://blog.csdn.net/lxysoid" }
                });
            });
            #endregion
        }

        // 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();
            }

            app.UseMvc();

            #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
            });
            #endregion
        }

到这,已经完成swagger的添加,F5运行调试,在域名后面输入/swagger,点击回车

在这里插入图片描述

可以看到,swagger将我们项目的接口(这里只有一个系统默认生成values接口)自动生成一个可视化的接口文档,点击对应接口,可以查看接口的相关信息,也可以在当前页进行简单的测试调用。

好的,以下是一个基本的 .NET Core Web API 的示例: 1. 打开 Visual Studio 9 2. 选择 "新建项目" 3. 在 "新建项目" 窗口中,选择 "ASP.NET Core Web 应用程序" 4. 命名你的应用程序,并选择 "API" 作为项目类型 5. 点击 "创建" 现在你已经有了一个基本的 .NET Core Web API 项目。接下来,我们需要创建一个控制器来处理 HTTP 请求。按照以下步骤操作: 1. 在解决方案中,右键单击 "Controllers" 文件夹 2. 选择 "添加" -> "新建项" 3. 在 "新建项" 窗口中,选择 "ASP.NET Core" -> "控制器类" 4. 命名你的控制器,并选择 "API Controller - 空" 作为模板 5. 点击 "添加" 现在你已经有了一个控制器类。在这个类中,你可以定义可以处理 HTTP 请求的方法。例如,以下是一个简单的控制器类,它包含一个 Get 方法,该方法返回一个字符串: ```csharp using Microsoft.AspNetCore.Mvc; [ApiController] [Route("[controller]")] public class HelloWorldController : ControllerBase { [HttpGet] public string Get() { return "Hello, World!"; } } ``` 这个控制器类使用了两个属性:`[ApiController]` 和 `[Route("[controller]")]`。这些属性告诉 ASP.NET Core,这是一个 API 控制器,并且这个控制器的路由前缀应该是控制器的名称。 现在你可以运行你的应用程序,并在浏览器中访问 `https://localhost:5001/helloworld`,你应该可以看到 "Hello, World!" 的输出。 这只是一个简单的例子,但它演示了如何创建一个基本的 .NET Core Web API。你可以在控制器类中定义更多的方法来处理不同的 HTTP 请求,并返回不同的数据。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值