附录 A. 参考资料


A.1. JAX-RS/RESTEasy Annotations

表 A.1. JAX-RS/RESTEasy Annotations
注解使用

cache

自动设置响应 Cache-Control 标头。

ClientInterceptor

将拦截器识别为客户端拦截器。

ContentEncoding

元注释,用于指定要通过注解的注解来应用的 Content-Encoding

上下文

允许您指定 javax.ws.rs.core.HttpHeaders , javax.ws.rs.core.UriInfo , javax.ws.rs.core.Request , javax.servlet.HttpServletRequest , javax.servlet.HttpServletResponse, 和 javax.ws.rs.core.SecurityContext 对象.

CookieParam

允许您在方法调用中指定 HTTP 请求 cookie 或对象表示的值。

DecorateTypes

必须放在 DecoratorProcessor 类上,以指定受支持的类型。

decorator

将 meta-annotation 放置到触发解码的另一个注解上。

DefaultValue

可以与其他 @*Param 注释结合使用,以在 HTTP 请求项目不存在时定义默认值。

删除

表示方法响应 HTTP DELETE 请求的注释。

DoNotUseJAXBProvider

当您不想使用 JAXB MessageBodyReader/Writer,但具有更具体的提供程序来托管类型时,请将它放入类或参数。

encoded

可用于类、方法或参数。默认情况下,注入 @PathParam@QueryParams 将被解码。通过添加 @Encoded 注释,这些 params 的值以编码形式提供。

表单

这可用作传入/传出请求/响应的值对象。

格式

使用缩进和换行格式化 XML 输出。这是 JAXB 调试器。

GET

表示方法响应 HTTP GET 请求的注释。

IgnoreMediaTypes

放置到类型、方法、参数或字段上,告知 JAX-RS 不使用 JAXB 提供程序作为特定的介质类型

ImageWriterParams

资源组可用于将参数传递给 IIOImageProvider 的注释。

映射

A JSONConfig.

MultipartForm

这可用作 multipart/form-data MIME 类型的传入/传出请求/响应的值对象。

noCache

设置 nocacheCache-Control 响应标头。

NoJackson

当您不希望触发 Jackson 提供程序时,将放置到类、参数、字段或方法。

PartType

写出 List 或 Map 作为多部分 /* 类型时,必须与多部分 供应商一起使用。

路径

这必须存在于类或资源方法中。如果两者中都存在,则资源方法的相对路径是类和方法的串联。

PathParam

允许您将变量 URI 路径片段映射到方法调用。

POST

表示方法响应 HTTP POST 请求的注释。

优先级

用于指示使用类的顺序的注释。使用带有较低值的整数参数表示更高的优先级。

提供者

在提供程序扫描阶段,将一个类标记为可由 JAX-RS 运行时发现为提供程序的类。

PUT

表示方法响应 HTTP PUT 请求的注释。

QueryParam

允许您将 URI 查询字符串参数或 URL 形式编码参数映射到方法调用。

ServerInterceptor

将拦截器识别为服务器端拦截器。

StringParameterUnmarshallerBinder

要放入另一个注解上的 meta-annotation,该注解会触发 StringParameterUnmarshaller 应用到基于字符串的注解注入器。

风格表

指定 XML 样式表标头。

wrapped

在您要托管或解译 JAXB 对象的集合或数组时,将此放在方法或参数中。

WrappedMap

当您要托管或解译 JAXB 对象的映射时,将其放置到方法或参数中。

XmlHeader

为返回的文档设置 XML 标头。

XmlNsMap

A JSONToXml.

XopWithMultipartRelated

此注释可用于处理/生产传入/传出的 XOP 消息(打包为多部分/相关)与/从 JAXB 注释的对象处理/传出。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.