java - 从 enunciate doc 工具中排除一些剩余方法

Question

我正在使用 enunciate 来记录我的 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);
}

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

Answer 1

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