建设一个购物网站多少钱,专门做外卖的网站,新版网站上线,百度网络营销推广Swagger是一个描述RESTful的Web API的规范和框架。如果使用ASP.NET的话#xff0c;可以用Swashbuckle来自动生成Swagger,具体参考如何使 WebAPI 自动生成漂亮又实用在线API文档。下面详细的介绍一下如何给ASP.NET Core的项目自动生成Swagger的API帮助文档。 创建ASP.NET Core的… Swagger是一个描述RESTful的Web API的规范和框架。如果使用ASP.NET的话可以用Swashbuckle来自动生成Swagger,具体参考如何使 WebAPI 自动生成漂亮又实用在线API文档。下面详细的介绍一下如何给ASP.NET Core的项目自动生成Swagger的API帮助文档。 创建ASP.NET Core的Web API Controller 在Visual Studio 2015中创建一个ASP.NET Core的项目点击添加“New Item”“Server-side”“Web API Controller Class”。Visual Studio会帮我们自动创建一个如下的文件实现了一个标准的RESTful的Web API。 1234567891011121314151617181920212223242526272829303132333435[Route(api/[controller])]public class ValuesController : Controller{ // GET: api/values [HttpGet] public IEnumerablestring Get() { return new string[] { value1, value2 }; } // GET api/values/5 [HttpGet({id})] public string Get(int id) { return value; } // POST api/values [HttpPost] public void Post([FromBody]string value) { } // PUT api/values/5 [HttpPut({id})] public void Put(int id, [FromBody]string value) { } // DELETE api/values/5 [HttpDelete({id})] public void Delete(int id) { }} 添加Swashbuckle的Nuget包 打开project.json文件添加Swashbuckle的依赖Swashbuckle.SwaggerGen和Swashbuckle.SwaggerUi。注意我们要使用6.0的版本这是针对ASP.NET Core的。它的github地址Ahoy也和之前的版本不一样了。 12345678910dependencies: { Microsoft.AspNet.IISPlatformHandler: 1.0.0-rc1-final, Microsoft.AspNet.Mvc: 6.0.0-rc1-final, Microsoft.AspNet.Mvc.Core: 6.0.0-rc1-final, Microsoft.AspNet.Server.Kestrel: 1.0.0-rc1-final, Microsoft.AspNet.SignalR.Server: 3.0.0-rc1-final, Microsoft.AspNet.StaticFiles: 1.0.0-rc1-final, Swashbuckle.SwaggerGen: 6.0.0-rc1-final, Swashbuckle.SwaggerUi: 6.0.0-rc1-final}, 在Startup.cs中配置Swashbuckle 1234567891011121314public void ConfigureServices(IServiceCollection services){ // ... services.AddSwaggerGen(); // ...}public void Configure(IApplicationBuilder app){ // ... app.UseSwaggerGen(); app.UseSwaggerUi(help); // API文档的地址默认是 /swagger/ui // ...} 运行项目查看API文档也能直接测试 万事俱备运行项目打开地址就能看到如下的API文档了还能直接在这里测试Web API。 相关文章 WebAPI前置知识:HTTP与RestfulAPIWEB API系列一WEB API的适用场景、第一个实例WEB API 系列二 Filter的使用以及执行顺序ASP.NET Web API 安全筛选器Web API 基于ASP.NET Identity的Basic AuthenticationASP.NET Web Api使用CacheCow和ETag缓存资源使用 West Wind WebSurge 对 ASP.NET Web API 服务进行压力测试Web API应用支持HTTPS的经验总结Dion Hinchcliffe谈Web API的过去与未来WebAPI生成可导入到PostMan的数据如何使 WebAPI 自动生成漂亮又实用在线API文档 原文地址http://fresky.github.io/2016/06/08/use-swashbuckle-to-add-swagger-api-help-for-asp-net-core/ .NET社区新闻深度好文微信中搜索dotNET跨平台或扫描二维码关注
