vs中使用c#创建、开发、调试和发布webapi详细教程

2022年9月19日 6150点热度 2人点赞 0条评论

现在无论开发什么系统或项目，编程工具是net或java，webapi都是不可缺少的模块之一。它使项目间的数据交互变得简单。如果你是net程序员，那么使用微软的vs(visual studio)工具创建webapi是个不错的选择。这篇就是教你如何用vs创建webapi？希望对你有帮助

一、创建和开发

1.创建新的项目

2.选择.NET CORE的ASP .NET CORE WEB应用程序

3.定义项目名称和存放地点

4.选择API创建项目

5.删除原本的无用的类

6.添加新的方法类

7.设置路由

using Microsoft.AspNetCore.Components;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace WEBAPI.Controllers
{

    /// <summary>
    /// 设置路由
    /// </summary>
    [Route("api/[controller]/[action]")]
    public class Calculation
    {


    }
}

8.下面开始写你所需要的接口方法

我们分别创建get和post两个方法
方法如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace WEBAPI.Controllers
{

    /// <summary>
    /// 设置路由
    /// </summary>
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class Calculation
    {

        /// <summary>
        /// 获取文本
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<string> Get()
        {
            return "Hello World!";
        }
        /// <summary>
        /// 两数相加
        /// </summary>
        /// <param name="num1">第一个数</param>
        /// <param name="num2">第二个数</param>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<int> Sum(int num1, int num2)
        {
            return num1 + num2;
        }
        /// <summary>
        /// 两数相减
        /// </summary>
        /// <param name="param">参数</param>
        /// <returns></returns>
        [HttpPost]
        public ActionResult<int> Subtract(Param param)
        {
            int result = param.num1 - param.num2;
            return result;
        }


    }

    /// <summary>
    /// 参数
    /// </summary>
    public class Param
    {
        /// <summary>
        /// 第一个数
        /// </summary>
        public int num1 { get; set; }
        /// <summary>
        /// 第二个数
        /// </summary>
        public int num2 { get; set; }
    }
}

9.开始调试

在调试中修改路径为api/Calculation/get
开始运行,结果为

二、项目调试

为了方便对api接口进行管理和调试,我使用了Swagger框架。为了更好地可视化运行我的接口

1.为项目添加NuGet包

Swashbuckle.AspNetCore

2.在Startup的ConfigureServices方法里加入代码

注册Swagger生成器，定义一个文档，设置xml文档的注释路径

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            //配置Swagger
            //注册Swagger生成器，定义一个Swagger 文档
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1",
                    Title = "接口文档",
                    Description = "RESTful API"
                });
                // 为 Swagger 设置xml文档注释路径
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
            });
            services.AddMvc(x => x.EnableEndpointRouting = false);

3.在Configure方法里加入下面的代码

启用中间件服务使用生成Swagger和SwaggerUI

//启用中间件服务生成Swagger
            app.UseSwagger();
            //启用中间件服务生成Swagger，指定Swagger JSON终结点
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
                c.RoutePrefix = string.Empty;//设置根节点访问
            });
            app.UseMvc();