0

我使用发音来记录我的 REST API。我能够正确生成文档并且已经使用了很长一段时间。

我现在的问题是......我很少有具有多个端点方法的服务类。

public interface UserLoginService {
//This method should be DOcumented
@Path("/login")
@POST
@Consumes({"application/xml", "application/json"})
@Produces({"application/xml", "application/json"})
@Transactional(
 readOnly=false, 
rollbackForClassName="MyExceptionClass", 
propagation=Propagation.REQUIRED
)
@Deprecated
public UserDetails performLogin(LoginObj loginobj);


//This method should be skipped

@Path("/logout")
@GET
@Consumes({"application/xml", "application/json"})
@Produces({"application/xml", "application/json"})
@Transactional(
readOnly=false, 
rollbackForClassName="MyException", 
propagation=Propagation.REQUIRED
)
public UserDetails logout(@QueryParam("userid") String userid);
}

在这些服务方法中，有些是公共的，有些是内部使用的。我只想为那些应该公开的 Rest 方法生成文档。尽管我使用排除 api 类来排除类，但我在发音中搜索无论如何都找不到跳过一些方法。有什么办法可以做到这一点。我不想只创建单独的类 bcoz 文档。如果发音要执行此操作，则可以轻松地从现有的发音 javadoc 中改编任何其他文档工具。

4

2 回答 2

1

仅供参考，1.27 版将包含Enunciate Facets的概念，在排除 API 的方面时更加灵活。

于 2013-07-06T20:14:14.417 回答
0

我使用的是旧版本的发音。最新版本有一个注解@ExcludeFromDocumentation。虽然我看到了这个注解它是用 doc 写的，这仅适用于 Jaxb objs。我在他们的 jira 中看到了针对我的问题提出并修复的缺陷。这个注解现在可以用于 classes/methods 。如果针对 REST 方法使用，则不会记录该方法。

于 2013-06-14T02:34:01.227 回答