001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.test.autoconfigure.restdocs;
018
019import org.springframework.restdocs.restassured3.RestAssuredRestDocumentationConfigurer;
020
021/**
022 * A customizer for {@link RestAssuredRestDocumentationConfigurer}. If a
023 * {@code RestDocsRestAssuredConfigurationCustomizer} bean is found in the application
024 * context it will be {@link #customize called} to customize the
025 * {@code RestAssuredRestDocumentationConfigurer} before it is applied. Intended for use
026 * only when the attributes on {@link AutoConfigureRestDocs} do not provide sufficient
027 * customization.
028 *
029 * @author Eddú Meléndez
030 * @since 2.0.0
031 */
032@FunctionalInterface
033public interface RestDocsRestAssuredConfigurationCustomizer {
034
035        /**
036         * Customize the given {@code configurer}.
037         * @param configurer the configurer
038         */
039        void customize(RestAssuredRestDocumentationConfigurer configurer);
040
041}