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);
}

在这些服务方法中，有些是公开的，有些是在内部使用的。我想为那些应该公开的Rest方法生成doc。我在enunciate中搜索无法找到跳过几个方法，虽然我使用排除api类来排除类。有什么方法可以实现这一点。我不想创建单独的类只有bcoz的文档。如果发音剂量这样做任何其他文档工具，可以很容易地从现有的enaviate javadoc编写。

Answer 1

仅供参考，版本1.27将包含Enunciate Facets的概念，可以更灵活地排除API的各个方面。

Answer 2

我正在使用旧版的enunciate。最新版本有一个注释@ExcludeFromDocumentation。虽然我看到了这个注释，但是在doc中写道，这仅适用于Jaxb objs。我在他们的jira中看到了一个缺陷，并为我的问题解决了问题。此注释现在可用于类/方法。如果用于REST方法，则不会记录该方法。

从enunciate doc工具中排除少数休息方法

2 个答案: