【发布时间】：2016-10-21 02:09:54
【问题描述】：
我曾多次在单页应用程序和本地项目中使用 Web API。 但是现在我想知道其他公司的用户在使用我们的API服务时如何理解我们的模型结构， 例如发布数据（发布船只日期）。他们如何理解我们的船只类别结构？我们应该将我们的班级以单独的文件发送给公司吗？ 考虑到通过在程序源中添加WCF和Web服务，可以为我们提供模型、方法及其结果等整体结构，使用Web API是否合乎逻辑？
【问题讨论】：
标签： asp.net-web-api
【发布时间】：2016-10-21 02:09:54
【问题描述】：
您可以创建一个 Web API 帮助/文档页面，其中将列出您的所有公共 API 以及参数、返回类型等。
有两种方法可以做到这一点
- Web API 帮助页面，参考 - https://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages
- 你可以使用swagger集成它，参考-http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/
在这两种情况下，您都需要使用 XML cmets 注释您的 API 方法
【讨论】：
-
这是否回答了您的问题。如果是，请将其标记为答案。