com.holonplatform.jaxrs.swagger.internal.ApiGroupId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of holon-jaxrs-swagger Show documentation

Holon JAX-RS Swagger integration

There is a newer version: 5.7.0

/*
 * Copyright 2000-2017 Holon TDCN.
 * 
 * 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
 * 
 * http://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 com.holonplatform.jaxrs.swagger.internal;

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

/**
 * Annotation which can be used to specify the API group id.
 * 
 * @see SwaggerApiListingResource
 * 
 * @since 5.0.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface ApiGroupId {

	/**
	 * Default API group id
	 */
	public static final String DEFAULT_GROUP_ID = "default";

	/**
	 * The API group id
	 * @return the API group id
	 */
	String value();

}