Asp.net使用Swagger生成API在线文档


引用Swagger的Nuget包

在这里插入图片描述

引用成功后在项目中生成一个SwaggerConfig.cs文件

在这里插入图片描述

设置Swagger输出的文档路径

在这里插入图片描述

测试方法
 public class ApiTestController : ApiController
    {
        static List<User> _users = new List<User>() {
            new User(){ Id=1,Name="李四",Address="北京"},
            new User(){ Id=2,Name="李四",Address="山西"},
            new User(){ Id=3,Name="张三",Address="上海"}
        };

        /// <summary>
        /// 获取单个用户数据
        /// </summary>
        /// <param name="id">根据ID获取</param>
        /// <returns></returns>
        [Route("User/{id}")]
        [HttpGet]
        public User Get(int id)
        {
            var user = _users.FirstOrDefault(x => x.Id == id);
            return user;
        }

        /// <summary>
        /// 获取全部用户数据
        /// </summary>
        /// <param name="name">根据名称获取</param>
        /// <returns></returns>
        [Route("User")]
        [HttpGet]
        public List<User> GetUsers()
        {
            return _users;
        }

        /// <summary>
        /// 添加数据
        /// </summary>
        /// <param name="request">添加信息</param>
        /// <returns></returns>
        [Route("User")]
        [HttpPost]
        public User Post(User request)
        {
            _users.Add(request);
            return request;
        }
        /// <summary>
        /// 更新数据
        /// </summary>
        /// <param name="id">编号</param>
        /// <param name="request">用户信息</param>
        /// <returns></returns>
        [Route("User/{id}")]
        [HttpPut]
        public string Put(int id, User request)
        {
            var user = Get(id);
            _users.Remove(user);
            _users.Add(request);
            var a = "更新数据成功为,更新前数据名称为:" + user.Name + ",更新后数据名称为:" + request.Name;
            return a;
        }
        /// <summary>
        /// 删除数据
        /// </summary>
        /// <param name="id">根据ID删除</param>
        /// <returns></returns>
        [Route("User/{id}")]
        [HttpDelete]
        public string Delete(int id)
        {
            var user = Get(id);
            _users.Remove(user);
            return "删除成功";
        }
    }
下面是运行后的结果

在这里插入图片描述
获取全部用户信息
在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值