《Asp.Net Core3 + Vue3入坑教程》-Net Core项目搭建与Swagger配置步骤 (2)

新建Controllers文件夹，新增ValuesController

代码如下：

using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; // For more information on enabling Web API for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860 namespace Simple_Asp.Net_Core.Controllers { [Route("api/[controller]")] [ApiController] public class ValuesController : ControllerBase { // GET: api/<ValuesController1> [HttpGet] public IEnumerable<string> Get() { return new string[] { "value1", "value2" }; } // GET api/<ValuesController1>/5 [HttpGet("{id}")] public string Get(int id) { return "value"; } // POST api/<ValuesController1> [HttpPost] public void Post([FromBody] string value) { } // PUT api/<ValuesController1>/5 [HttpPut("{id}")] public void Put(int id, [FromBody] string value) { } // DELETE api/<ValuesController1>/5 [HttpDelete("{id}")] public void Delete(int id) { } } } 运行网站

利用swagger调用接口

请求结果返回404的错误，发现路由配置错误，修改路由配置

再次运行项目，调用接口，这一次成功返回消息！

最后一步取消警告

由于引入了Swagger导致VS多了CS1591警告，也可以不取消此警告

Simple项目的搭建与Swagger配置结束！ 总结

Swagger作为前后端分离开发必备工具，不仅可以作为前后端同事交流的文档也有助于我们更直观的管理API文档。在开发过程中针对Controller的职能与用途，需要做好必要注释、良好的注释为前后端交流和后期维护都有很重要的作用。

GitHub源码

注意：源码调试过程中如果出现xml文件路径错误，需要参照Swagger配置“配置XML 文档文件”步骤，取消勾选然后再选中 ，将XML路径设置成与你的电脑路径匹配！

https://github.com/Impartsoft/Simple_Asp.Net_Core/tree/master/Simple_Asp.Net_Core 1.Swagger

参考资料

博客（推荐学习） https://www.cnblogs.com/laozhang-is-phi/p/9495618.html

微软官方文档 https://docs.microsoft.com/zh-cn/aspnet/core/?view=aspnetcore-5.0

Swagger官网 https://swagger.io/