（二）.netcore+vue 如何测试接口

时间：2021-04-21 12:41:15 阅读：0 评论：0 收藏：0 [点我收藏+]

标签：rtu ret swagger document 开启文档 route 改变 json

一、swagger组件

swagger的主要作用是API接口文档+接口调试的作用

在WeatherForecastController里加了另外4个方法，如何调用接口呢？如何进行断点调试呢？

 /// <summary>
        /// 查询
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

        /// <summary>
        /// 根据id查询
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet("{id}")]
        public ActionResult<string> Get(int id)
        {
            return "Get by id";
        }
   
        /// <summary>
        /// 新增
        /// </summary>
        /// <param name="value"></param>
        /// <returns></returns>
        [HttpPost]
        public ActionResult<string> Post([FromBody] string value)
        {
            return "Insert";
        }

        /// <summary>
        /// 修改
        /// </summary>
        /// <param name="id"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        [HttpPut("{id}")]
        public ActionResult<string> Put(int id, [FromBody] string value)
        {
            return "Edit";
        }
       
        /// <summary>
        /// 删除
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete("{id}")]
        public ActionResult<string> Delete(int id)
        {
            return "Delete by id";
        }

1、引入Swagger

技术图片

2.ConfigureServices 里配置swagger

首先，项目右键编辑项目文件，写如下代码，表示把注释生成到指定目录下的XML文件里

<PropertyGroup Condition="‘$(Configuration)|$(Platform)‘==‘Debug|AnyCPU‘">
        <DocumentationFile>bin\Debug\net5.0\EmptyTemplate.APICore.xml</DocumentationFile>
        <OutputPath>bin\Debug\net5.0\</OutputPath>
    </PropertyGroup>

    <PropertyGroup Condition="‘$(Configuration)|$(Platform)‘==‘Release|AnyCPU‘">
        <DocumentationFile>bin\Release\net5.0\EmptyTemplate.APICore.xml</DocumentationFile>
        <OutputPath>bin\Release\net5.0\</OutputPath>
    </PropertyGroup>

然后，Startup 的ConfigureServices 里配置swagger

 #region Swagger
            services.AddSwaggerGen(c =>
            {
               
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "EmptyTemplate.Api", Version = "v1" });

                //导入XML文件信息
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath,true);
            });

            #endregion

3.Configure里开启swagger中间件

首先，launchSettings.json 文件里，把launchUrl改为空

然后，Startup的Configure里开启swagger

#region Swagger

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "EmptyTemplate.Api V1");
                c.RoutePrefix = ""; //路径配置，首页配置为swagger首页，去launchSettings.json把launchUrl去掉
            });

            #endregion