了解Web api服务中模型的结构

Question

我在单页面应用程序和本地项目中多次使用Web API。 但现在我想知道其他公司的用户在使用我们的API服务时如何理解我们的模型结构， 例如，用于发布数据（邮寄船舶日期）。他们可以了解我们的船级结构吗？我们应该将我们的课程单独发送给公司吗？ 考虑到通过向程序源添加WCF和Web服务，可以为我们提供整个结构，例如模型，方法及其结果，使用Web API是否合乎逻辑？

Answer 1

您可以创建一个Web API帮助/文档页面，其中列出了所有公共API以及参数，返回类型等。

有两种方法可以做到这一点

1. Web API帮助页面，请参阅 - https://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages
2. 您可以使用swagger进行整合，请参阅http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/

在这两种情况下，您都需要使用XML注释来注释API方法