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 > などの他のタグのビルド規則がある場所) を調べてみました。これは、 < response > を処理することになっていると思います:

<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