run.halo.app.extension.router.IListRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
API of halo project, connecting by other projects.
The newest version!
package run.halo.app.extension.router;

import static org.springdoc.core.fn.builders.parameter.Builder.parameterBuilder;

import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collections;
import java.util.List;
import org.springdoc.core.fn.builders.operation.Builder;
import org.springframework.boot.convert.ApplicationConversionService;
import org.springframework.core.convert.ConversionService;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;

public interface IListRequest {

    @Schema(description = "The page number. Zero indicates no page.")
    Integer getPage();

    @Schema(description = "Size of one page. Zero indicates no limit.")
    Integer getSize();

    @Schema(description = "Label selector for filtering.")
    List getLabelSelector();

    @Schema(description = "Field selector for filtering.")
    List getFieldSelector();

    class QueryListRequest implements IListRequest {

        protected final MultiValueMap queryParams;

        private final ConversionService conversionService =
            ApplicationConversionService.getSharedInstance();

        public QueryListRequest(MultiValueMap queryParams) {
            this.queryParams = queryParams;
        }

        @Override
        public Integer getPage() {
            var page = queryParams.getFirst("page");
            if (StringUtils.hasText(page)) {
                return conversionService.convert(page, Integer.class);
            }
            return 0;
        }

        @Override
        public Integer getSize() {
            var size = queryParams.getFirst("size");
            if (StringUtils.hasText(size)) {
                return conversionService.convert(size, Integer.class);
            }
            return 0;
        }

        @Override
        public List getLabelSelector() {
            return queryParams.getOrDefault("labelSelector", Collections.emptyList());
        }

        @Override
        public List getFieldSelector() {
            return queryParams.getOrDefault("fieldSelector", Collections.emptyList());
        }
    }

    static void buildParameters(Builder builder) {
        builder.parameter(parameterBuilder()
                .in(ParameterIn.QUERY)
                .name("page")
                .implementation(Integer.class)
                .required(false)
                .description("Page number. Default is 0."))
            .parameter(parameterBuilder()
                .in(ParameterIn.QUERY)
                .name("size")
                .implementation(Integer.class)
                .required(false)
                .description("Size number. Default is 0."))
            .parameter(parameterBuilder()
                .in(ParameterIn.QUERY)
                .name("labelSelector")
                .required(false)
                .description("Label selector. e.g.: hidden!=true")
                .implementationArray(String.class))
            .parameter(parameterBuilder()
                .in(ParameterIn.QUERY)
                .name("fieldSelector")
                .required(false)
                .description("Field selector. e.g.: metadata.name==halo")
                .implementationArray(String.class)
            );
    }
}