使用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 MVC5使用MiniProfiler监控MVC性能

    ASP.NET MVC5使用MiniProfiler监控MVC性能

    这篇文章主要为大家详细介绍了ASP.NET MVC5使用MiniProfiler监控MVC性能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • Web开发异常行为排查常用方法图文介绍

    Web开发异常行为排查常用方法图文介绍

    平常程序遇到错误,开发环境下一般都用调试搞定,生产环境下通过查看日志搞定。但也有搞不定的时候,本文提供了详细的解决方案
    2012-11-11
  • 利用.net core实现反向代理中间件的方法

    利用.net core实现反向代理中间件的方法

    这篇文章主要给大家介绍了关于利用.net core实现反向代理中间件的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用.net core具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-09-09
  • ASP.NET中弹出消息框的几种常见方法

    ASP.NET中弹出消息框的几种常见方法

    这篇文章主要介绍了ASP.NET中弹出消息框的几种常见方法,给出了几种常见的弹出消息框的方法,并总结对比了几种方法的特点,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-11-11
  • Asp.net在页面间传递大量数据(数据表)建议采用的方法

    Asp.net在页面间传递大量数据(数据表)建议采用的方法

    能让数据在 两个不同站点之间传递吗,针对这个问题将会展开本文的探讨有想在A站点的数据传递到B站点的朋友们可以适当参考下,或许本文对你有所帮助
    2013-02-02
  • 某个aspx页面突然死了连日志也没有的解决方法

    某个aspx页面突然死了连日志也没有的解决方法

    某个aspx页面突然死了连日志也没有,朋友提醒event viewer里看看,果然错误在那里,有此情况的朋友可以参考下
    2013-08-08
  • C# Lambda表达式用途深入理解

    C# Lambda表达式用途深入理解

    假如我们想要从一个整型数组中取出其中是奇数的选项,其实现方式有很多,接下来通过三种方法的对比理解Lambda表达式的用途,需要了解的朋友可以参考下
    2012-12-12
  • ASP.Net页尾中添加JavaScript的最佳方法实战分享

    ASP.Net页尾中添加JavaScript的最佳方法实战分享

    将JavaScript脚本或库添加到asp.net页的末尾方法有很多,究竟哪一个最好使呢有利于日后的维护啊,是个疑点啊,本文的出现将帮你解决所有的困惑,感兴趣的你可不要错过了哈
    2013-02-02
  • Request.UrlReferrer中文乱码解决方法

    Request.UrlReferrer中文乱码解决方法

    参考了网络大部分的解决方案,没一个能搞定的,如果穷途末路,试试下面的方法:将获得的前一页面的URL分成两段,后面的参数部分进行编码(直接对URL编码是不行的),然后再组合一下就可以了,需要的朋友可以了解下
    2012-12-12
  • asp.net下URL处理两个小工具方法

    asp.net下URL处理两个小工具方法

    asp.net下URL处理两个小工具方法...
    2007-04-04

最新评论