发音Spring注释API留档

Question

我在一个maven项目中使用expertion来生成REST API文档。

工件maven-en

我尝试用支持spring的maven工件生成文档，但是它甚至不能生成Web API文档。

有没有一种方法可以配置expertion或使用另一个expertion maven插件，以便来自Spring的注释被识别并在expertion生成的文档中被提及？




Answer 1

恐怕不是。发音无法识别这些 Spring 注释，尽管可以添加该功能。欢迎您提出请求。

(< code > maven-expertion-spring-plugin 只是用来让expertion wire在Spring中连接到后端运行时，它不包括你所询问的特性。)

Answer 2

匿名用户

没关系，我通过“将自定义皮肤应用于Enunciate的文档”(html" target="_blank">http://docs.codehaus.org/display/ENUNCIATE/Applying自定义皮肤来阐述Enunciate的文档)解决了这个问题

我修改了< code > declaration-docs 的< code>docs.xml.fmt和< code>docs.fmt，因此可以识别' @Secured '注释。

不幸的是，对于< code>docs.xml.fmt，没有像我们对< code>docs.fmt一样的清晰的定制方法。所以，我不得不用这些修改过的文件来包装自己。

我提到了如何处理“已弃用”（java.lang.弃用），并遵循了类似的方法。

在＜code＞文档中。fmt文件，将此块添加到isDeprected的类似功能块下面

[#function isSecured element]
  [#return (getTagValues(element, "secured")?size > 0)/]
[/#function]

现在

就在这个街区下面:

[#if isDeprecated(resource)]
 <p class="alert">This resource has been deprecated.</p>
[/#if]

添加另一个 if 块

[#if isSecured(resource)]
  <p class="note">This resource is available only to these roles:  
  [#assign securedTags = getTagValues(resource, "secured") /]
  [#if securedTags?size > 0]
    ${securedTags[0]}
  [/#if]

  [#list resource.parent.annotations as tag]
      ${tag}
  [/#list]
  </p>
[/#if]

现在，在＜code＞docs.xml中。fmt文件，就在下面：

[#if resource.parent.annotations["java.lang.Deprecated"]??]
  <tag name="deprecated"/>
[/#if]

添加以下块

[#if resource.parent.annotations["org.springframework.security.access.annotation.Secured"]??]
  <tag name="secured">

    [#list resource.parent.annotations["org.springframework.security.access.annotation.Secured"]["value"] as roles]
      <![CDATA[${roles}]]> 
    [/#list]

  </tag>
[/#if]