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

2021-05-30 09:06

阅读：741

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

一、swagger组件

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

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

 /// 
        /// 查询
        /// 
        /// 
        [HttpGet]
        public IEnumerable 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();
        }

        /// 
        /// 根据id查询
        /// 
        /// 
        /// 
        [HttpGet("{id}")]
        public ActionResultstring> Get(int id)
        {
            return "Get by id";
        }
   
        /// 
        /// 新增
        /// 
        /// 
        /// 
        [HttpPost]
        public ActionResultstring> Post([FromBody] string value)
        {
            return "Insert";
        }

        /// 
        /// 修改
        /// 
        /// 
        /// 
        /// 
        [HttpPut("{id}")]
        public ActionResultstring> Put(int id, [FromBody] string value)
        {
            return "Edit";
        }
       
        /// 
        /// 删除
        /// 
        /// 
        /// 
        [HttpDelete("{id}")]
        public ActionResultstring> Delete(int id)
        {
            return "Delete by id";
        }

1、引入Swagger

技术图片

2.ConfigureServices 里配置swagger

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

"‘$(Configuration)|$(Platform)‘==‘Debug|AnyCPU‘">
        bin\Debug\net5.0\EmptyTemplate.APICore.xmlbin\Debug\net5.0\"‘$(Configuration)|$(Platform)‘==‘Release|AnyCPU‘">
        bin\Release\net5.0\EmptyTemplate.APICore.xmlbin\Release\net5.0\

然后，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

4.运行项目

项目的起始文件改变了，不再是之前的 WeatherForecast，而是http://localhost:50853/index.html，并且每个Action上的注释都显示出来了

技术图片

5.断点调试

我们在Post方法里设置断点，然后点击页面上Post方法后面的Try it out，然后输入入参，点击Excute，断点就进入方法里了。

技术图片

6.swagger加授权认证

这一点后面学授权时再补充。

二、postman工具

这种更适用于调用别人的接口时使用

以后有时间再补充。

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

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

原文地址：https://www.cnblogs.com/WorkhardNi/p/14680525.html

上一篇：执行 npm install --save swiper/css/swiper.css 失败以及autoplay原配置不生效解决方案

下一篇：（三）.netcore+vue 项目搭建、EF Code First

文章来自：搜素材网的编程语言模块，转载请注明文章出处。
文章标题：（二）.netcore+vue 如何测试接口
文章链接：http://soscw.com/index.php/essay/89499.html

亲，登录后才可以留言！

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

一、swagger组件

1、引入Swagger

2.ConfigureServices 里配置swagger

3.Configure里开启swagger中间件

4.运行项目

5.断点调试

6.swagger加授权认证

二、postman工具

评论

热门文章

推荐文章

最新文章

置顶文章