从enunicate doc工具中排除几个rest方法

Question

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

我现在的问题是…我有几个具有多个endpoint方法的服务类。

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中改编。

Answer 1

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

Answer 2

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