Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/java/321.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Java 从阐明文档工具中排除一些rest方法_Java_Web Services_Documentation_Javadoc_Enunciate - Fatal编程技术网

Java 从阐明文档工具中排除一些rest方法

Java 从阐明文档工具中排除一些rest方法,java,web-services,documentation,javadoc,enunciate,Java,Web Services,Documentation,Javadoc,Enunciate,我使用Enounceate来记录我的RESTAPI。我能够正确地生成文档,并且已经使用它很长时间了 我现在的问题是。。我有几个具有多个端点方法的服务类 public interface UserLoginService { //This method should be DOcumented @Path("/login") @POST @Consumes({"application/xml", "application/json"}) @Produces({"application/xml",

我使用Enounceate来记录我的RESTAPI。我能够正确地生成文档,并且已经使用它很长时间了

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

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方法生成文档。我在Enounciate中搜索,但无论如何都找不到跳过几个方法,尽管我使用exclude api类来排除类。
有没有办法做到这一点。我不想只创建一个单独的类。如果enunciate dosent这样做,那么任何其他文档工具都可以很容易地从现有enunciate javadoc中进行改编。

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

仅供参考,1.27版将包含在排除API方面更灵活的概念