io.github.yedaxia.apidocs.doc.HtmlControllerDocBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of japidocs Show documentation
sonatype
There is a newer version: 1.4.4
package io.github.yedaxia.apidocs.doc;

import io.github.yedaxia.apidocs.parser.ParamNode;
import io.github.yedaxia.apidocs.Resources;
import io.github.yedaxia.apidocs.Utils;
import io.github.yedaxia.apidocs.codegenerator.ios.ModelCodeGenerator;
import io.github.yedaxia.apidocs.codegenerator.java.JavaCodeGenerator;
import io.github.yedaxia.apidocs.parser.ControllerNode;
import io.github.yedaxia.apidocs.parser.RequestNode;

import java.io.IOException;

/**
 *
 * build html api docs for a controller
 *
 * @author yeguozhong yedaxia.github.com
 */
public class HtmlControllerDocBuilder implements IControllerDocBuilder{

    @Override
    public String buildDoc(ControllerNode controllerNode) throws IOException{

        final String ctrlTemplate = getControllerTpl();

        String ctrlDoc = ctrlTemplate;

        if (Utils.isNotEmpty(controllerNode.getDescription())) {
            ctrlDoc = ctrlDoc.replace("${CONTROLLER_DESCRIPTION}", controllerNode.getDescription());
        }

        final String actionTemplte = getActionTpl();

        StringBuilder actionsBuilder = new StringBuilder();
        StringBuilder tocBuilder = new StringBuilder();
        String actionDoc;
        for (RequestNode requestNode : controllerNode.getRequestNodes()) {
            actionDoc = actionTemplte;
            if (Utils.isNotEmpty(requestNode.getDescription())) {
                String descriptionHtml = requestNode.getDeprecated() ? String.format("%s", requestNode.getDescription()) : requestNode.getDescription();
                actionDoc = actionDoc.replace("${ACTION_DESCRIPTION}", descriptionHtml);
                String tocActionHtml = requestNode.getDeprecated() ? "%s
" : "%s";
                tocBuilder.append(String.format(tocActionHtml, requestNode.getDescription(),
                        requestNode.getDescription()));
            }
            if (Utils.isNotEmpty(requestNode.getMethod())) {
                actionDoc = actionDoc.replace("${METHOD}", requestNode.getMethod());
            }
            if (Utils.isNotEmpty(requestNode.getUrl())) {
                actionDoc = actionDoc.replace("${APIURL}", controllerNode.getBaseUrl() + requestNode.getUrl());
            }
            if (requestNode.getParamNodes() != null) {
                StringBuilder paramListBuilder = new StringBuilder();
                for (ParamNode paramNode : requestNode.getParamNodes()) {
                    paramListBuilder.append("");
                    paramListBuilder.append(String.format("%s%s%s%s",
                            paramNode.name, paramNode.type, paramNode.required, paramNode.description));
                    paramListBuilder.append("");
                }
                actionDoc = actionDoc.replace("${PARAM_LIST}", paramListBuilder.toString());
            }

            if (requestNode.getResponseNode() != null) {
                actionDoc = actionDoc.replace("${RESPONSE}", requestNode.getResponseNode().toJsonApi());
                JavaCodeGenerator javaCodeGenerator = new JavaCodeGenerator(requestNode.getResponseNode());
                String javaurl = javaCodeGenerator.generateCode();
                actionDoc = actionDoc.replace("${ANDROID_CODE}", javaurl);
                ModelCodeGenerator iosCodeGenerator = new ModelCodeGenerator(requestNode.getResponseNode());
                String iosUrl = iosCodeGenerator.generateCode();
                actionDoc = actionDoc.replace("${IOS_CODE}", iosUrl);
            }
            actionsBuilder.append(actionDoc);
        }
        ctrlDoc = ctrlDoc.replace("${TOC}", tocBuilder.toString());
        ctrlDoc = ctrlDoc.replace("${ACTION_LIST}", actionsBuilder.toString());
        return ctrlDoc;
    }

    private String getControllerTpl() throws IOException{
        return Utils.streamToString(Resources.getTemplateFile("api-controller.html.tpl"));
    }

    private String getActionTpl() throws IOException{
        return Utils.streamToString(Resources.getTemplateFile("api-action.html.tpl"));
    }
}