欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档

程序员文章站 2024-02-29 12:35:40
...

首先实现在MVC项目中使用WebAPI


使用ASP.NET MVC项目的时候,需要给APP开发人员提供接口,可以直接在MVC项目里面添加API控制器。

方法如下:

1 在项目根目录添加区域文件夹Areas,已有则忽略

2 在Areas目录上右键,添加区域,区域名称随意,我的是API

3 在Areas/API/Controllers目录上右键添加控制器,选择WebApi控制器,确定。VS自动引用相关dll并生成WebAPI的配置文件(强大的VS)。ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档

4 删除上面简历的区域下的多余的文件及目录只留下Controllers目录即可

5 在根目录的Global.asax文件中注册WebAPI的路由代码如下

GlobalConfiguration.Configure(WebApiConfig.Register);

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档

6 至此WebAPI已经可以正常访问了


然后添加Swagger API文档

1 在引用处右键-管理NuGet程序包

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档

2 搜索并添加包  Swashbuckle

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档

3 项目属性-生成勾选输出XML,课自定义xml名称,复制这个路径,下一步用得到

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档 4 打开App_Start目录下的SwaggerConfig.cs,查找代码IncludeXmlComments定位到XML路径配置处,配置一下XML的路径

string xmlPath = string.Format(@"{0}/bin/MuMVC.Web.xml",System.AppDomain.CurrentDomain.BaseDirectory);
c.IncludeXmlComments(xmlPath);

5 生成项目

6 访问地址http****/swagger,完成

ASP.NET MVC项目中添加使用WebAPI并加入Swagger API文档