org.javalite.activeweb.EndPointDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aw-mate Show documentation
This plugin will generate Open API - compliant document from sources of an ActiveWeb app.
There is a newer version: 3.3
package org.javalite.activeweb;

import org.javalite.json.JSONParseException;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;


import static org.javalite.common.Util.blank;



/**
 * Wraps multiple HTTP methods for a single endpoint.  For instance:
 * http://university.com/api/students may have two methods: GET and POST, one to get students, another to save,
 * each with different semantics and documentation.
 */
public class EndPointDefinition {

    private final List endpointMethods = new ArrayList<>();
    private final String path;
    private final String controllerClassName;
    private final String actionMethodName;
    private final String argumentClassName; // can be null


    public EndPointDefinition(EndPointHttpMethod endpointMethod, String path, String controllerClassName,
                              String actionMethod, String argumentClassName) {

        this.endpointMethods.add(endpointMethod);
        this.path = path;
        this.argumentClassName = argumentClassName;
        this.controllerClassName = controllerClassName;
        this.actionMethodName = actionMethod;
    }

    /**
     *
     * @param endpointMethods
     * @param path whatever was specified in the RouteConfig for this route.
     * @param controllerClassName
     * @param actionMethod
     * @param argumentClassName
     */
    public EndPointDefinition(List endpointMethods, String path, String controllerClassName,
                              String actionMethod, String argumentClassName) {

        this.endpointMethods.addAll(endpointMethods);
        this.path = path;
        this.argumentClassName = argumentClassName;
        this.controllerClassName = controllerClassName;
        this.actionMethodName = actionMethod;
    }


    public String getActionMethodName() {
        return actionMethodName;
    }

    public String getDisplayControllerMethod() {
        return blank(argumentClassName) ? actionMethodName + "()" : actionMethodName + "(" + argumentClassName + ")";

    }

    public List getEndpointMethods() {
        return endpointMethods;
    }

    public List getHTTPMethods() {
        return this.endpointMethods.stream().map(EndPointHttpMethod::getHttpMethod).collect(Collectors.toList());
    }

    public String getPath() {
        return path;
    }

    public String getArgumentClassName() {
        return argumentClassName;
    }

    public String getControllerClassName() {
        return controllerClassName;
    }

    public boolean hasOpenAPI() {
        boolean hasAPI = false;
        for (EndPointHttpMethod endpointHttpMethod : endpointMethods) {
            if(!blank(endpointHttpMethod.getHttpMethodAPI())){
                hasAPI = true;
            }
        }
        return hasAPI;
    }

    public boolean contains(EndPointHttpMethod[] endpointHttpMethods) {
        for (EndPointHttpMethod endpointHttpMethod : endpointHttpMethods) {
             if(!this.endpointMethods.contains(endpointHttpMethod)){
                 return false;
             }
        }
        return true;
    }


    /**
     *
     * @return a map that looks like:
     * 
     * {
     *  "post": { "summary" : "Add new pet" ....},
     *  "put":  { "summary" : "Update existing pet" ....}
     *  }
     *  
     *  
     */
    Map> getEndpointAPI(){

        Map> apiMethods =   new HashMap<>();
        for (EndPointHttpMethod endPointHttpMethod : endpointMethods) {
            try{
                apiMethods.put(endPointHttpMethod.getHttpMethod().name().toLowerCase(), endPointHttpMethod.getAPIAsMap());
            }catch(JSONParseException e){
                throw new JSONParseException("Failed to parse docs into JSON for: " + this.getControllerClassName() + ", path: " + this.path + ":" +  endPointHttpMethod.getHttpMethod().name(), e);
            }
        }
        return apiMethods;
    }

    public void addEndpointMethod(List endpointMethod) {

    }
}