1

我正在重新设计 API 文档的样式。我们正在使用带有restdoclet的maven。我们用于 API 描述的通用代码如下所示：

/**
 * <name>API name</name>
 * <description>API description</description>
 * <type>API type</type>
 * <versions>
 *  <version>
 *   <number>1</number>
 *   <response>{"success":true}</response>
 *  </version>
 * </versions>
 * 
 * @param request
 * @param version API version
 * @param param1 first parameter
 * @param param2 (optional) second parameter
 * @return
 */

javadoc 是自动生成的。问题是有时 <response> 的内容（基本上是 api 返回的内容）显示正确（颜色、缩进），在其他情况下它根本不显示。

旧文档中有一些 API 响应错误，所以我认为这是导致它的原因。有一些调用就像一个魅力，但是仍然有一些 API 没有得到正确的格式或者只是得到了一部分响应（这种情况只发生在某些情况下，当调用返回一个值数组时）。

让我感到困惑的是，我看不出代码有什么不同，但有些响应是正确构建的，有些则不是。我试图查看一些 xsl 配置文件（其中有其他标签的构建规则，例如 <name>、<type>、<version>）。这就是我认为它应该处理的<响应>：

<div class="{substring-after(../../../uri/uri, '/')}-response-{number}">
 <script type="text/javascript">
  jQuery(function($) {
   var json = <xsl:value-of select="response"/>;
   JSONFormatter.format(json, {
    'collapse': false,
    'appendTo': '.<xsl:value-of select="substring-after(../../../uri/uri,'/')"/>-response-<xsl:value-of select="number"/>',
    'list_id': 'json-<xsl:value-of select="substring-after(../../../uri/uri,'/')"/>-<xsl:value-of select="number"/>'
   });
  });
 </script>
</div>

所以它可能与 JSONFormatter 有关，但我不明白它在哪里失败，以及为什么只是一些。

任何想法？

4

0 回答 0