spring-graphql SchemaMapping 源码

  • 2022-08-16
  • 浏览 (689)

spring-graphql SchemaMapping 代码

文件路径:/spring-graphql/src/main/java/org/springframework/graphql/data/method/annotation/SchemaMapping.java

/*
 * Copyright 2002-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.graphql.data.method.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import graphql.schema.DataFetchingEnvironment;

import org.springframework.core.annotation.AliasFor;

/**
 * Annotation to express the mapping of a handler method to a GraphQL type and
 * field pair.
 *
 * <p>You can use this annotation both at the method and at the class level, in
 * which case all handlers methods inherit the class-level typeName by default
 * unless overridden at the method level.
 *
 * @author Rossen Stoyanchev
 * @since 1.0.0
 */
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SchemaMapping {

	/**
	 * Customize the name of the GraphQL field to bind to.
	 * <p>By default, if not specified, this is initialized from the method name.
	 */
	@AliasFor("value")
	String field() default "";

	/**
	 * Effectively an alias for {@link #field()}.
	 */
	@AliasFor("field")
	String value() default "";

	/**
	 * Customizes the name of the source/parent type for the GraphQL field.
	 * <p>By default, if not specified, it is derived from the class name of a
	 * {@link DataFetchingEnvironment#getSource() source} argument injected into
	 * the handler method.
	 * <p>This attributed is supported at the class level and at the method level!
	 * When used on both levels, the one on the method level overrides the one
	 * at the class level.
	 */
	String typeName() default "";

}

相关信息

spring-graphql 源码目录

相关文章

spring-graphql Argument 源码

spring-graphql Arguments 源码

spring-graphql BatchMapping 源码

spring-graphql ContextValue 源码

spring-graphql LocalContextValue 源码

spring-graphql MutationMapping 源码

spring-graphql QueryMapping 源码

spring-graphql SubscriptionMapping 源码

spring-graphql package-info 源码

0  赞