使用vs2019加.net core 对WeiApi的创建过程详解

 更新时间:2020年07月03日 11:25:17   作者:BIN_Coisini  
这篇文章主要介绍了使用vs2019加.net core 对WeiApi的创建,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

vs2019创建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.下面开始写你所需要的接口方法

我们分别创建一个post两个get的方法

方法如下

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

4.然后右击项目继续选择属性,在生成中选择输出路径

并且勾选xml文档

5.清空调试的路径

6.直接启动

到此这篇关于使用vs2019加.net core 对WeiApi的创建过程详解的文章就介绍到这了,更多相关vs2019加.net core 对WeiApi的创建内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • asp.net使用AJAX实现无刷新分页

    asp.net使用AJAX实现无刷新分页

    AJAX(Asynchronous JavaScript and XML)是一种进行页面局部异步刷新的技术。用AJAX向服务器发送请求和获得服务器返回的数据并且更新到界面中,不是整个页面刷新,而是在页面中使用Js创建XMLHTTPRequest对象来向服务器发出请求以及获得返回的数据。
    2014-11-11
  • 用.Net的File控件上传文件的解决方案

    用.Net的File控件上传文件的解决方案

    用.Net的File控件上传文件的解决方案...
    2007-04-04
  • asp.net ubb使用代码

    asp.net ubb使用代码

    asp.net ubb使用代码,以前脚本之家曾经发过一篇稍有区别的代码,大家一起参考下吧。
    2009-12-12
  • C# 添加文字水印类代码

    C# 添加文字水印类代码

    可以添加文字水印的c# 类函数。
    2009-05-05
  • 在Code First模式中自动创建Entity模型

    在Code First模式中自动创建Entity模型

    这篇文章介绍了在Code First模式中自动创建Entity模型的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • 浅析.Net Core中Json配置的自动更新

    浅析.Net Core中Json配置的自动更新

    这篇文章主要介绍了浅析.Net Core中Json配置的自动更新,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • 微信公众平台开发之处理图片.Net代码解析

    微信公众平台开发之处理图片.Net代码解析

    这篇文章主要为大家详细解析了微信公众平台开发之处理图片.Net代码,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • asp.net listbox实现单选全选取消

    asp.net listbox实现单选全选取消

    这篇文章主要介绍了asp.net listbox单选全选取消的应用,需要的朋友可以参考下
    2014-02-02
  • .Net Core日志记录之日志配置

    .Net Core日志记录之日志配置

    这篇文章介绍了.Net Core日志记录之日志配置,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • .NET Core使用SkiaSharp实现快速生成二维码

    .NET Core使用SkiaSharp实现快速生成二维码

    这篇文章主要为大家详细介绍了.NET Core如何使用SkiaSharp实现快速生成二维码,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-01-01

最新评论