Swagger可以自动生成Api说明文档,并内置在线测试,通过NSwagStudio还可以自动生成Api客户端调用代码,以下为具体实现步骤
1、写一个简单的WebApi并加上注释
1 public class ValuesController : ApiController 2 { 3 4 /// <summary> 5 /// 这是一个Post测试 6 /// </summary> 7 /// <param name="para"></param> 8 /// <returns></returns> 9 [HttpPost] 10 public JsonResult<object> GetJsonValue([FromBody]InputValue para) 11 { 12 using (IDbConnection cn = new SqlConnection(ConfigurationManager.ConnectionStrings["DefaultConnection"].ConnectionString)) 13 { 14 cn.Open(); 15 var ret = SqlMapper.Query(cn, "select * from AbpRoles where Id = @id", new { Id = para.Id }); 16 return Json<object>(ret); 17 } 18 } 19 20 21 /// <summary> 22 /// 传入参数 23 /// </summary> 24 public class InputValue 25 { 26 /// <summary> 27 /// 主键 28 /// </summary> 29 public int Id { get; set; } 30 /// <summary> 31 /// 名称 32 /// </summary> 33 public string Name { get; set; } 34 } 35 }