当前位置：首页 > news >正文

Swagger学习⑭——@Contact注解

news 2025/7/14 22:17:54

介绍

@Contact 是 Swagger/OpenAPI 3.0 注解中的一个注解，用于定义 API 文档中的联系信息。通过 @Contact 注解，你可以指定 API 维护者的联系方式，例如电子邮件、URL 或名称等。

源代码

package io.swagger.v3.oas.annotations.info;import io.swagger.v3.oas.annotations.extensions.Extension;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface Contact {String name() default "";String url() default "";String email() default "";Extension[] extensions() default {};
}

注解属性

@Contact 注解有以下常用属性：

name: 联系人姓名或团队名称。
url: 联系人的 URL 地址，通常是一个支持页面或联系页面。
email: 联系人的电子邮件地址。

作用

@Contact 注解通常与 @Info 注解一起使用，作为 @Info 注解的一个属性。@Info 注解用于定义 API 文档的基本信息，而 @Contact 则用于指定联系信息。

使用场景

在编写 API 文档时，通常需要提供 API 维护者的联系方式，以便用户或开发者能够联系到相关人员。@Contact 注解可以帮助你在生成的 OpenAPI 文档中定义这些联系信息。

示例代码

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Contact;
import io.swagger.v3.oas.annotations.info.Info;@OpenAPIDefinition(info = @Info(title = "Demo API",version = "1.0.0",description = "这是一个Demo API 文档",contact = @Contact(name = "API 支持团队",email = "demo@chengxuyuanshitang.com"))
)
public class DemoApi {// Demo API 方法}