【原创】ASP.NET Web API教程（三）

　　六、接口描述文档

　　ASP.NET Web API虽然是服务端的接口，但当它发布到IIS之后，运行时，由于缺少默认页面，浏览器将看不到正常的页面显示。同时，对于客户端开发者来说，如果看不到web api的源码，也没有其他文档描述接口，就不知道有哪些接口可以调用，各自的参数是怎么样的。为此，web api专门提供了HelpPage来根据接口上面的注释生成接口描述文档，而且使用起来也很简单，主要用【NuGet】安装【Microsoft.AspNet.WebApi.HelpPage】即可。

　　1. 在上一篇【ASP.NET Web API入门教程【5】-按方法名调用】创建的项目上添加描述文档

　　2. 在项目上点击右键 ->【管理 NuGet程序包】

　　3. 在NuGet界面，点击【浏览】->输入【help】，待搜索完成后，选择【Microsoft.AspNet.WebApi.HelpPage】，在右侧点击【安装】，之后弹出的各种确认框，都点击确定即可。

　　安装完成后，会在项目中增加【Areas】文件夹，并包含很多文件与代码。

　　4. 在【Global.asax】文件的【ApplicationStart】方法中增加【AreaRegistration.RegisterAllAreas();】，可能需要引入【using System.Web.Mvc;】。

　　5. 在【DefaultController】的Get方法上添加注释，然后，运行项目，并修改地址，展示Help页面(此时并没有按照预期显示方法上面的描述)。

　　6.显示接口描述

　　1)取消【AreasHelpPageAppStartHelpPageConfig.cs】文件中Register方法的部分注释。

　　2)在项目上点击右键 ->【属性】。

　　3)选择【配置】->【启动项目】。

　　4)在【命令列表】中，找到【调试】->【启用调试】，勾选【启用调试】。

　　5)重新运行项目，访问Help页面，可以看到接口描述已经显示正常。

　　七、总结

　　在本篇教程中，我们学习了如何为ASP.NET Web API生成接口描述文档，并通过NuGet安装Microsoft.AspNet.WebApi.HelpPage来实现。这使得开发者能够更轻松地了解和调用接口，提高了开发效率。接下来，我们将深入学习如何使用ASP.NET Web API进行身份验证和授权，以及如何使用Entity Framework Core进行数据库操作。

（编辑：厦门网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!