如何记录 Azure 移动服务后端答案

【问题标题】：How to document Azure Mobile Services Backend如何记录 Azure 移动服务后端
【发布时间】：2014-10-25 01:09:47
【问题描述】：

大家好，我有一个关于 Microsoft 的 Azure 移动服务的问题。我想为 Azure 移动服务门户（url .azure-mobile.net 上的那个）制作文档，让我的朋友知道当您提出请求时自定义 API 应该做什么。我用谷歌搜索了它，但没有找到任何东西，标准 C# 样式文档什么也没显示。它必须能够记录它，因为在网站上它告诉我没有可用的文档或排序。

【问题讨论】：

运气好能找到解决这个“问题”的方法吗？我也在努力记录我的 API，并认为这不应该那么难......
不，伙计。下面的答案有点相关，因为 api 管理基本上是为了限制 api 调用和记录那一边，然后比单独的服务器更公开，你只能使用来自 azure 的主密钥进行连接
另外，我尝试过 doxygen 类型的文档，希望它能生成一些文档，但到目前为止还没有 cigar...
感谢提供信息的伙伴，那他们为什么要在文档页面中显示该信息？哈哈
到目前为止还没有任何线索......但是为团队中的其他编码人员修改它可能会非常好，并且不要依赖其他文档解决方案，如 doxygen 或类似的东西

标签： c# html asp.net azure asp.net-web-api

【解决方案1】：

在帮助页面上显示标准 C# 文档非常简单。

基本上是为了这个：

    /// <summary>
    /// Creates a new user account.
    /// </summary>
    /// <param name="model">Object containing the basic information about the user.</param>
    /// <returns>User with the basic data and the JWT token.</returns>
    /// <exception cref="BusinessLogicException">
    /// Throws business exception if the user that is being created contains invalid data, such as invalid email, username and so on.
    /// </exception>
    public async Task<ResponseMessage<UserLogin>> Post(PostUserModel model)
    {
        ...
    }

变成这样：

您只需：

右键单击您的 Mobile Services .NET 项目项目（在 Visual Studio 中）
转到属性
选中“XML 文档文件”复选框（如下图）

有关更多帮助页面自定义选项，请关注此资源： http://www.codeproject.com/Articles/819848/Master-the-Managed-Azure-Mobile-Services-Backend

【讨论】：

谢谢陛下！抱歉耽搁了，但昨天是我再次遇到这个问题的那天

【解决方案2】：

试用 Azure API 管理。它将为您的用户创建一个开发人员门户，其中包含文档、测试控制台等，以及提供分析、配额等的管理门户。您可以找到更多详细信息here。

【讨论】：