Application API Documentation

Directional Consulting

Classes

ApiController extends AbstractController in package

Endpoint controller for Incoming XML bounce, fetch, and target /api routes

Tags
Route

("/api")

Table of Contents

$logger  : LoggerInterface
Pass in the system logger interface
$params  : ParameterBagInterface
Application parameters from config/*.yaml
__construct()  : mixed
ApiController constructor.
healthApiAction()  : mixed
Provides /api/health endpoint for checking server and database health
finishController()  : mixed

Properties

$logger

Pass in the system logger interface

private LoggerInterface $logger

$params

Application parameters from config/*.yaml

private ParameterBagInterface $params

Methods

__construct()

ApiController constructor.

public __construct(ParameterBagInterface $params, LoggerInterface $logger[, Profiler|null $profiler = null ]) : mixed
Parameters
$params : ParameterBagInterface
$logger : LoggerInterface
$profiler : Profiler|null = null
Return values
mixed

healthApiAction()

Provides /api/health endpoint for checking server and database health

public healthApiAction(Request $request) : mixed
Parameters
$request : Request
Tags
FOSRest\Post

("/health", name=".health")

OA\Post

( path="/api/health", summary="API Health Check for Application", description="Checks for XML post parameters and returns health status", operationId="healthApiAction", @OA\Response( response=200, description="Either status OK, WARNING or CRITICAL returned with status message" ), @OA\RequestBody( @OA\XmlContent( @OA\Xml(name="health"), @OA\Property(property="auth", type="array", @OA\Items(type="string")), @OA\Property(property="route", type="array", collectionFormat="multi", @OA\Items(type="string")), @OA\Property(property="verbose", type="array", collectionFormat="multi", @OA\Items(type="boolean")), required={"token", "route"} ), ), ), ) )

Return values
mixed

finishController()

private finishController(Agent $agent[, null $exception = null ]) : mixed
Parameters
$agent : Agent
$exception : null = null
Return values
mixed

        

Search Results

Search results

Found Results