org.apache.sling.testing.tools.http
Class RequestDocumentor

java.lang.Object
  org.apache.sling.testing.tools.http.RequestDocumentor

public class RequestDocumentor
extends java.lang.Object

Generate RESTful API documentation based on actual requests executed during integration tests, enhanced with user-supplied bits of documentation.

Field Summary

static java.lang.String

OUTPUT_BASE

Constructor Summary

RequestDocumentor(java.lang.String name)

Method Summary

protected void	documentRequest(java.io.PrintWriter pw, RequestExecutor executor, java.lang.String[] metadataArray)
protected java.io.File	getOutputFile()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OUTPUT_BASE

public static final java.lang.String OUTPUT_BASE

Constructor Detail

RequestDocumentor

public RequestDocumentor(java.lang.String name)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOutputFile

protected java.io.File getOutputFile()

documentRequest

protected void documentRequest(java.io.PrintWriter pw,
                               RequestExecutor executor,
                               java.lang.String[] metadataArray)
                        throws java.io.IOException

Throws:

java.io.IOException