springfox.documentation.spring.web.scanners.ApiListingReferenceScanner.java Source code

Introduction

Here is the source code for springfox.documentation.spring.web.scanners.ApiListingReferenceScanner.java

Source

/*
 *
 *  Copyright 2015-2016 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
 *
 *         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 springfox.documentation.spring.web.scanners;

import com.google.common.collect.ArrayListMultimap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import springfox.documentation.RequestHandler;
import springfox.documentation.service.ResourceGroup;
import springfox.documentation.spi.service.contexts.ApiSelector;
import springfox.documentation.spi.service.contexts.DocumentationContext;
import springfox.documentation.spi.service.contexts.RequestMappingContext;

import static com.google.common.collect.FluentIterable.*;
import static com.google.common.collect.Multimaps.*;

@Component
public class ApiListingReferenceScanner {

    private static final Logger LOG = LoggerFactory.getLogger(ApiListingReferenceScanner.class);

    public ApiListingReferenceScanResult scan(DocumentationContext context) {
        LOG.info("Scanning for api listing references");

        ArrayListMultimap<ResourceGroup, RequestMappingContext> resourceGroupRequestMappings = ArrayListMultimap
                .create();
        ApiSelector selector = context.getApiSelector();
        Iterable<RequestHandler> matchingHandlers = from(context.getRequestHandlers())
                .filter(selector.getRequestHandlerSelector());
        for (RequestHandler handler : matchingHandlers) {
            ResourceGroup resourceGroup = new ResourceGroup(handler.groupName(), handler.declaringClass(), 0);

            RequestMappingContext requestMappingContext = new RequestMappingContext(context, handler);

            resourceGroupRequestMappings.put(resourceGroup, requestMappingContext);
        }
        return new ApiListingReferenceScanResult(asMap(resourceGroupRequestMappings));
    }

}