初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试

简介: 初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试


VsualStudio2022各版本说明

VsualStudio2022企业版和社区版区别是收费和不收费。社区版是免费的。

主页链接:【Visual Studio 2022 IDE - 适用于软件开发人员的编程工具

主要面向学生、开源软件开发者等个人,我们大学生肯定是免费使用的。

专业版与企业版则是收费的,更多面向高级开发者或企业用户。

VisualStudio2022软件一共有Community(社区版)、Professional(专业版)与 Enterprise(企业版)三个版本。我们使用社区版本就够用了。

社区版本具体说明

社区版本在测试过程中

  1. 社区版不支持TFS。但你可以另外搭建TFS服务,只是个人开发不需要这个东西。
  2. 社区版有单元测试。没有性能测试,没有负载测试,没有性能分析。
  3. 社区版创建虚拟环境的能力不行。

VisualStudio2022下载选项

VisualStudio2022启动样式

VisualStudio2022图标样式

VisualStudio2022初始内存消耗

创建项目ASP.NET Core项目

具体项目创建

这里可以在筛选中依次选择【C#】=>【Windows】=>【Web】,在列表中选择【ASP.NET Core Web API】来快速创建接口

编辑项目名称与项目位置

创建配置

这里默认是【.Net6.0】是一个长期稳定版本,使用3.1也是一个稳定版本。

取消【HTTPS】,这样省的麻烦。我们又没有单独去购买HTTPS所以不需要。

勾选【使用控制器】,为了方便。

一定要勾选上【OpenAPI】这样能自动添加swagger

非常干净的页面创建成功。

创建API控制器

鼠标右键直接添加【控制器】

修改路由配置

[Route("api/[controller]/[action]")]

如果没有这个路由的话访问起来会很麻烦。

配置跨域

看好代码放置位置,才能正确配置。

//注册跨域请求CORS服务
builder.Services.AddCors(options =>
{
    options.AddPolicy("AllowCors", builder =>
    {
        builder.AllowAnyOrigin().AllowAnyMethod();
    });
});
//启动跨域
app.UseCors("AllowCors");

准备创建接口

创建Model

就准备一个做数据的类就够了。我们创建一个【Product】类。

public string? ProductId { get; set; }
public string? ProductName { get; set; }
public string? ProductType { get; set; }
public decimal Price { get; set; }
public string? note { get; set; }

创建一个【SUCCESS】类用于返回正确结果

public SUCCESS(string msg,Object result) {
    state = true;
    this.msg = msg;
    this.result = result;
}
public bool state { get; set; }
public string? msg { get; set; }
public Object? result { get; set; }

创建一个【ERROR】类用于返回异常结果

这里的【result】返回为null,别用字符串啥的,免得被移动端的开发乱bb

public ERROR(string msg)
{
    state = false;
    this.msg = msg;
    this.result = null;
}
public bool state { get; set; }
public string? msg { get; set; }
public Object? result { get; set; }

创建【RESTful风格】的API接口

接口测试业务逻辑梳理:

1、初始化数据[HttpGet]

2、基础列表分页访问测试[HttpGet]

3、精准id查询测试[HttpGet]

4、模糊查询测试[HttpGet]

5、分组查询测试[HttpGet]

6、倒序正序查询测试[HttpGet]

7、添加测试[HttpPost]

8、修改测试[HttpPut]

9、删除测试[HttpDelete]

完整接口代码(复制就能用)

/// <summary>
        /// 全局数据
        /// </summary>
        static List<Product> list = new List<Product>();
        /// <summary>
        /// 初始化函数
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public object Init()
        {
            if (list.Count < 1)
            {
                return new ERROR("初始化完毕");
            }
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "中药",
                ProductName = "枸杞",
                Price = decimal.Parse("3.99"),
                note = "养生必备"
            });
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "中药",
                ProductName = "党参",
                Price = decimal.Parse("2.05"),
                note = "健脾益肺"
            });
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "蔷薇目",
                ProductName = "葎草",
                Price = decimal.Parse("5.72"),
                note = "性寒,走肺经与肾经,易导致过敏性呼吸道疾病。"
            });
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "蔷薇目",
                ProductName = "单倍体草莓",
                Price = decimal.Parse("92.99"),
                note = "单倍体无籽草莓,"
            });
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "蔷薇目",
                ProductName = "草莓",
                Price = decimal.Parse("109.25"),
                note = "八倍体的凤梨草莓"
            });
            list.Add(new Product()
            {
                ProductId = Guid.NewGuid().ToString("N"),
                ProductType = "杂草",
                ProductName = "香附子(有毒)",
                Price = decimal.Parse("6.92"),
                note = "生、醋炒、酒炒、碳炒,主解表通络。"
            });
            return list;
        }
        /// <summary>
        /// 综合查询
        /// </summary>
        /// <param name="pageNow"></param>
        /// <param name="pageSize"></param>
        /// <param name="ProductId"></param>
        /// <param name="ProductName"></param>
        /// <param name="isDesc"></param>
        /// <returns></returns>
        [HttpGet]
        public object GetInfo(int pageNow, int pageSize, string? ProductId, string? ProductName, bool isDesc)
        {
            try
            {
                if (pageSize == 0)
                {
                    pageSize = 5;
                }
                var newList = list;
                if (!string.IsNullOrEmpty(ProductId))
                {
                    newList = list.Where(o => o.ProductId == ProductId).ToList();
                }
                if (!string.IsNullOrEmpty(ProductName))
                {
                    newList = list.Where(o => o.ProductName.Contains(ProductName)).ToList();
                }
                if (isDesc)
                {
                    newList = newList.OrderByDescending(by => by.Price).ToList();
                }
                newList = newList.Skip((pageNow - 1) * pageSize).Take(pageSize).ToList();
                return new SUCCESS("查询成功", newList);
            }
            catch (Exception)
            {
                return new ERROR("查询失败");
            }
        }
        /// <summary>
        /// 分组查询
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public object GetGroupByType()
        {
            try
            {
                var newList = list.GroupBy(o => o.ProductType).ToList();
                return new SUCCESS("查询成功", newList);
            }
            catch (Exception)
            {
                return new ERROR("查询失败");
            }
        }
        /// <summary>
        /// 添加数据
        /// </summary>
        /// <param name="product"></param>
        /// <returns></returns>
        [HttpPost]
        public object InsertProduct(Product product)
        {
            product.ProductId = Guid.NewGuid().ToString("N");
            if (
                string.IsNullOrEmpty(product.ProductName) ||
                string.IsNullOrEmpty(product.ProductType) ||
                product.Price == decimal.Zero ||
                string.IsNullOrEmpty(product.note)
                )
            {
                return new ERROR("参数不允许有空值");
            }
            list.Add(product);
            return new SUCCESS("添加成功", product);
        }
        /// <summary>
        /// 修改操作
        /// </summary>
        /// <param name="product"></param>
        /// <returns></returns>
        [HttpPut]
        public object UpdateById(Product product)
        {
            try
            {
                if (product == null)
                {
                    return new ERROR("参数不允许有空值");
                }
                for (int i = 0; i < list.Count; i++)
                {
                    if (list[i].ProductId == product.ProductId)
                    {
                        list[i] = product; break;
                    }
                }
                return new SUCCESS("修改成功", product);
            }
            catch (Exception)
            {
                return new ERROR("添加失败");
            }
        }
        [HttpDelete]
        public object DeleteById(string ProductId)
        {
            try
            {
                if (string.IsNullOrEmpty(ProductId))
                {
                    return new ERROR("参数不允许有空值");
                }
                for (int i = 0; i < list.Count; i++)
                {
                    if (list[i].ProductId == ProductId)
                    {
                        bool isf = list.Remove(list[i]);
                        return new SUCCESS("删除成功", isf);
                    }
                }
                return new ERROR("删除失败");
            }
            catch (Exception)
            {
                return new ERROR("删除失败");
            }
        }

启动前设置

点击【调试】=》【开始执行(不调试)】

启动效果

Web端swagger效果:

Eolink测试测试:

由于我不想挨个输入,故而直接使用【Swagger.json】来导入项目

在新的页面打开json文件

保存json文件到任意地方。

打开Eolink的APIkit,引入swagger.json文件

导入需要一点时间

执行完毕后就会看到【导入成功】,正在写入项目,所以任务显示【进行中】。

由于没有异步刷新,故而需要手动切换一下页面重新加载。

接口查看

添加本地访问环境

这里匹配好端口号,跟服务器要相同。

设置环境

环境设置成功效果如下:

访问测试:

根据需求进行测试即可,非常快捷方便。

总结:

非常实用、快捷、高效的API接口创建方法。设置跨域也很方便。

使用Eolink可以直接导入测试,那就是更方便了。

希望本视频能为大家带来一定的价值,节约大家的开发时间。

相关文章
|
5天前
|
人工智能 自然语言处理 API
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口,能够处理文本、音频和视频输入,提供自然流畅的对话体验,适用于多种应用场景。
39 3
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
|
7天前
|
XML JSON 缓存
阿里巴巴商品详情数据接口(alibaba.item_get) 丨阿里巴巴 API 实时接口指南
阿里巴巴商品详情数据接口(alibaba.item_get)允许商家通过API获取商品的详细信息,包括标题、描述、价格、销量、评价等。主要参数为商品ID(num_iid),支持多种返回数据格式,如json、xml等,便于开发者根据需求选择。使用前需注册并获得App Key与App Secret,注意遵守使用规范。
|
6天前
|
JSON API 开发者
淘宝买家秀数据接口(taobao.item_review_show)丨淘宝 API 实时接口指南
淘宝买家秀数据接口(taobao.item_review_show)可获取买家上传的图片、视频、评论等“买家秀”内容,为潜在买家提供真实参考,帮助商家优化产品和营销策略。使用前需注册开发者账号,构建请求URL并发送GET请求,解析响应数据。调用时需遵守平台规定,保护用户隐私,确保内容真实性。
|
6天前
|
搜索推荐 数据挖掘 API
淘宝天猫商品评论数据接口丨淘宝 API 实时接口指南
淘宝天猫商品评论数据接口(Taobao.item_review)提供全面的评论信息,包括文字、图片、视频评论、评分、追评等,支持实时更新和高效筛选。用户可基于此接口进行数据分析,支持情感分析、用户画像构建等,同时确保数据使用的合规性和安全性。使用步骤包括注册开发者账号、创建应用获取 API 密钥、发送 API 请求并解析返回数据。适用于电商商家、市场分析人员和消费者。
|
16天前
|
JSON API 开发工具
淘宝实时 API 接口丨淘宝商品详情接口(Taobao.item_get)
淘宝商品详情接口(Taobao.item_get)允许开发者获取商品的详细信息,包括基本信息、描述、卖家资料、图片、属性及销售情况等。开发者需注册账号、创建应用并获取API密钥,通过构建请求获取JSON格式数据,注意遵守平台规则,合理使用接口,确保数据准确性和时效性。
|
17天前
|
JSON 安全 API
Python调用API接口的方法
Python调用API接口的方法
81 5
|
17天前
|
JSON 缓存 监控
淘宝商品详情接口(Taobao.item_get)丨淘宝API接口指南
淘宝商品详情接口(Taobao.item_get)允许开发者通过HTTP GET方法获取淘宝商品的详细信息,包括商品ID、价格、库存等。请求需包含key、secret、num_iid等必选参数,支持缓存及多种返回格式。此接口广泛应用于电商数据分析、商品选品、价格监控等领域,提升商家运营效率。
|
21天前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
32 4
|
21天前
|
JSON 搜索推荐 API
LAZADA关键词搜索API接口的获取与应用
Lazada作为东南亚领先的电商平台,为满足开发者和商户需求,开放了关键词搜索API接口。本文详细介绍该接口的获取与应用,助力提升电商业务效率。接口支持关键词搜索、指定搜索范围和排序方式,提供精准、灵活且全面的数据支持,促进电商应用和服务的优化与创新。
22 3
|
27天前
|
JSON API 数据库
电商拍立淘按图搜索API接口,数据格式示例
电商拍立淘按图搜索API接口系列为电商平台和购物应用提供了强大的图像搜索功能,以下是其文档说明的详细参考