view release on metacpan or  search on metacpan

docs/rest-api.txt  view on Meta::CPAN

POST /stepin?next_statement=1
POST /stepin?next_fragment=<integer>

Request the debugger step in to the next statement.

Returns 200 if successful and JSON in the body.  The JSON returned is the
same as reported by the GET /status URL

-------------------------------------------------------------------------

POST /stepover
POST /stepover?next_statement=1
POST /stepover?next_fragment=<integer>

Request the debugger step over the next statement.

Returns 200 if successful and JSON in the body.  The JSON returned is the
same as reported by the GET /status URL

-------------------------------------------------------------------------

POST /stepout
POST /stepout?next_statement=1
POST /stepout?next_fragment=<integer>

Request the debugger return from the current subroutine

Returns 200 if successful and JSON in the body.  The JSON returned is the
same as reported by the GET /status URL

-------------------------------------------------------------------------

POST /continue

Request the debugger continue execution.

Returns 200 if successful and JSON in the body.  The JSON returned is the
same as reported by the GET /status URL

-------------------------------------------------------------------------

POST /continue?nostop=1

Request the debugger continue execution.  The param nostop=1 instructs the
debugger to run the program to completion and not stop at any breakpoints.

Returns 204 if successful.

-------------------------------------------------------------------------

POST /eval

Request the debugger evaluate some Perl code in the debugged program's most
recent stack frame.  The request body contains JSON:
{
    wantarray: 0, 1 or undefined - scalar, list or void context
    code: String - The string to eval
}

Returns 200 if successful and the result in the body.  The body contents
should be decoded using Data::Transform::ExplicitMetadata
Returns 409 if there was an exception.  The body contents should be decoded
using Data::Transform::ExplicitMetadata

-------------------------------------------------------------------------

GET /getvar/<level>

Get a list of all the lexical variables at the specified stack level.

Returns 200 and JSON in the body
[
    {   name: String - Name of the variable, including the sigil
        href: String - URL to get the value of this variable
    },
    ...
]

Returns 404 if the requested stack level does not exist

-------------------------------------------------------------------------

GET /getvar/<level>/<varname>

Get the value of a Perl variable at the requested stack level.  The variable
must include its sigil.

Returns 200 and JSON in the body.  The returned JSON is an
encoded version of whatever the Perl code evaluated to.

-------------------------------------------------------------------------

GET /packageinfo/
GET /packageinfo/<Package::Name>

Get information about the named package, or main:: if no package is given.

Returns 200 and JSON in the body
{
    name: String - Package name
    packages: [  // List of packages under this package
                { 
                   name: String - Package name
                   href: URL (/packageinfo/<That::package::name>)
                },
                ...
             ],
    subroutines: [ // List of subroutine names in this package
                {
                    name: String - subroutine name including package
                    href: URL (/subinfo/<That::package::subname>)
                },
                ...
            ],
}

Returns 400 if the named package is not a valid package name
Returns 404 if the named package is not present

-------------------------------------------------------------------------

GET /subinfo/subname