• Home
• io.github.yedaxia
• japidocs
• 1.0
• source code
• IControllerDocBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package io.github.yedaxia.apidocs.doc;

import io.github.yedaxia.apidocs.parser.ControllerNode;
import io.github.yedaxia.apidocs.parser.ResponseNode;

import java.io.File;
import java.io.IOException;

/**
 * an interface of build a controller api docs
 *
 * @author yeguozhong yedaxia.github.com
 */
public interface IControllerDocBuilder {

    /**
     * build api docs and return as string
     *
     * @param controllerNode
     * @return
     */
    String buildDoc(ControllerNode controllerNode) throws IOException;

}