为 RestEasy 的 Web 服务参数添加描述？

发布于 2024-12-06 12:49:22 字数 574 浏览 1 评论 0原文

是否有某种方式/注释可以将描述添加到 RestEasy Web 服务的参数中？我浏览了 api -doc 的注释，但在那里什么也没找到。

这是为了添加描述，以便它们反映在 REST API 文档中，我将使用某些工具自动生成该文档。

Web 服务接口示例：

@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

原文

Is there some way/annotation by which I can add the description to the parameters of a RestEasy web service? I went through the api-doc of the annotations, but found nothing there.

This is in order to add the descriptions so that they are reflected in the REST API documentation which I'll be auto-generating using some tool.

An example web service interface:

@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

貪欢 2024-12-13 12:49:22

找到了这个方法。没有REST注释来添加参数描述。

解决方案是使用典型的 java-doc 注释。

例如

/** 
 * @param param0 Paging parameter
 * @param param1 Paging parameter
 * */
@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

Found the way for this. There is no REST annotation to add the parameter description.

The solution for this is to use the typical java-doc annotation.

e.g.

/** 
 * @param param0 Paging parameter
 * @param param1 Paging parameter
 * */
@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

回复收藏 0 原文

~没有更多了~