com.github.kongchen.swagger.docgen.mustache.MustacheOperation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-maven-plugin Show documentation
A maven build plugin which helps you generate API document during build phase
There is a newer version: 3.1.8
package com.github.kongchen.swagger.docgen.mustache;

import com.github.kongchen.swagger.docgen.DocTemplateConstants;
import com.github.kongchen.swagger.docgen.GenerateException;
import com.wordnik.swagger.core.ApiValues;
import com.wordnik.swagger.model.Authorization;
import com.wordnik.swagger.model.Operation;
import com.wordnik.swagger.model.Parameter;
import com.wordnik.swagger.model.ResponseMessage;
import scala.collection.JavaConversions;
import scala.collection.mutable.Buffer;

import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import java.util.regex.Pattern;

public class MustacheOperation {
    private final int opIndex;

    private final String httpMethod;

    private final String summary;

    private final String notes;

    private final MustacheResponseClass responseClass;

    private final String nickname;
    private final List authorizations = new ArrayList();

    private List parameters;

    private MustacheParameterSet requestQuery;
    private MustacheParameterSet requestHeader;
    private MustacheParameterSet requestBody;
    private MustacheParameterSet requestPath;
    private MustacheParameterSet responseHeader;

    private static final Pattern genericInNotes = Pattern.compile("(/\\*.*<)((\\w+|((\\w+\\.)+\\w+))|(((\\w+|((\\w+\\.)+\\w+)),)+(\\w+|((\\w+\\.)+\\w+))))(>.*\\*/)");

    private List errorResponses;

    List samples;

    public MustacheOperation(MustacheDocument mustacheDocument, Operation op) {
        Buffer authorBuffer = op.authorizations().toBuffer();
        for(Authorization authorization : JavaConversions.asJavaList(authorBuffer)) {
            this.authorizations.add(new MustacheAuthorization(authorization));
        }
        this.opIndex = op.position();
        this.httpMethod = op.method();
        AbstractMap.SimpleEntry notesAndGenericStr = parseGenericFromNotes(op.notes());
        this.notes = notesAndGenericStr.getKey();
        this.summary = op.summary();
        this.nickname = op.nickname();
        Buffer buffer = op.parameters().toBuffer();
        this.parameters = mustacheDocument.analyzeParameters(JavaConversions.asJavaList(buffer));
        responseClass = new MustacheResponseClass(op.responseClass() + notesAndGenericStr.getValue());
        Buffer errorbuffer = op.responseMessages().toBuffer();
        this.errorResponses = JavaConversions.asJavaList(errorbuffer);
        if (parameters == null) {
            return;
        }
        for (MustacheParameterSet para : parameters) {
            if (para.getParamType().equals(ApiValues.TYPE_QUERY())) {
                this.requestQuery = para;
            } else if (para.getParamType().equals(ApiValues.TYPE_HEADER())) {
                this.requestHeader = para;
            } else if (para.getParamType().equals(ApiValues.TYPE_BODY())) {
                this.requestBody = para;
            } else if (para.getParamType().equals(ApiValues.TYPE_PATH())) {
                this.requestPath = para;
            } else if (para.getParamType().equals(DocTemplateConstants.TYPE_RESPONSE_HEADER)) {
                this.responseHeader = para;
            }
        }
    }

    private AbstractMap.SimpleEntry parseGenericFromNotes(String notes) {
        Scanner scanner = new Scanner(notes);
        String genericString = scanner.findInLine(genericInNotes);
        if (genericString != null) {
            return new AbstractMap.SimpleEntry(notes.replaceFirst(genericInNotes.pattern(), ""),
                    genericString.replaceAll("/\\*", "").replaceAll("\\*/", "").trim());
        } else {
            return new AbstractMap.SimpleEntry(notes, "");
        }
    }

    public List getAuthorizations() {
        return authorizations;
    }

    public MustacheParameterSet getResponseHeader() {
        return responseHeader;
    }

    public void setResponseHeader(MustacheParameterSet responseHeader) {
        this.responseHeader = responseHeader;
    }

    public MustacheParameterSet getRequestPath() {
        return requestPath;
    }

    public void setRequestPath(MustacheParameterSet requestPath) {
        this.requestPath = requestPath;
    }

    public MustacheParameterSet getRequestQuery() {
        return requestQuery;
    }

    public void setRequestQuery(MustacheParameterSet requestQuery) {
        this.requestQuery = requestQuery;
    }

    public MustacheParameterSet getRequestHeader() {
        return requestHeader;
    }

    public void setRequestHeader(MustacheParameterSet requestHeader) {
        this.requestHeader = requestHeader;
    }

    public MustacheParameterSet getRequestBody() {
        return requestBody;
    }

    public void setRequestBody(MustacheParameterSet requestBody) {
        this.requestBody = requestBody;
    }

    public List getSamples() {
        return samples;
    }

    public void setSamples(List samples) {
        this.samples = samples;
    }

    public int getOpIndex() {
        return opIndex;
    }

    public String getHttpMethod() {
        return httpMethod;
    }

    public String getSummary() {
        return summary;
    }

    public String getNotes() {
        return notes;
    }

    public String getNickname() {
        return nickname;
    }

    public List getParameters() {
        return parameters;
    }

    public List getErrorResponses() {
        return errorResponses;
    }

    public MustacheResponseClass getResponseClass() {
        return responseClass;
    }
}