A tool to help reverse engineer Swagger-PHP annotations from an existing JSON payload. See code for more info.
/**
*
* * * * * * * * * * * * * * * *
* Head (1 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\Get(
* path="/api/community-calendar-event/cities",
* tags={"Calendar"},
* summary="Get events",
* description="Calendar Events",
* security={{"bearerToken":{}}},
* [PROPORTIES]
* )
*
* * * * * * * * * * * * * * * *
* Path parameter (1 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\Parameter(
* in="path",
* name="itemId",
* required=true,
* @OA\Schema(
* type="integer",
* example=1,
* ),
* ),
*
* * * * * * * * * * * * * * * *
* Query parameter (1 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\Parameter(
* in="query",
* name="itemId",
* required=true,
* @OA\Schema(
* type="integer",
* example=1,
* ),
* ),
*
* * * * * * * * * * * * * * * *
* Empty response (6 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=204,
* description="Empty response"
* ),
*
* * * * * * * * * * * * * * * * * * * *
* Error response (6 tabs)
* * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=422,
* description="Unprocessable Content",
* @OA\JsonContent(
* @OA\Property(property="message", type="string", example="Error message"),
* @OA\Property(property="errors", type="object",
* @OA\Property(property="proporty", type="array",
* @OA\Items(type="string"),
* ),
* ),
* )
* ),
*
* * * * * * * * * * * * * * * * * * * *
* Response schema JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of game periods",
* @OA\JsonContent( type="array",
* @OA\Items(type="object", ref="#/components/schemas/Item"),
* )
* ),
*
* * * * * * * * * * * * * * * * * * * * * * * *
* Response schema array JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of game periods",
* @OA\JsonContent(type="object", ref="#/components/schemas/Contact")
* ),
*
* * * * * * * * * * * * * * * * * * * *
* Response Custom JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of calendar events",
* @OA\JsonContent(
* @OA\Property(property="status", type="boolean", example="test city"),
* )
* ),
*
* * * * * * * * * * * * * * * *
* Request JsonContent (6 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\RequestBody(
* required=true,
* description="Body of created event",
* @OA\JsonContent(
* required={"city", "community", "street", "uuid"},
* @OA\Property(property="city", type="string", example="test city"),
* @OA\Property(property="community", type="string", example="test community"),
* @OA\Property(property="street", type="string", example="test street"),
* @OA\Property(property="uuid", type="string", example="7edd2d9b-66be-4c45-900b-d7fe75a759cb"),
* ),
* ),
*
* * * * * * * * * * * * * * * *
* Request Multipart (6 tabs)
* * * * * * * * * * * * * * * *
*
* @OA\RequestBody(
* @OA\JsonContent(),
* @OA\MediaType(
* mediaType="multipart/form-data",
* @OA\Schema(
* type="object",
* required={"name","brand","ean", "container_type"},
* @OA\Property(property="image", type="file"),
* @OA\Property(property="name", type="text"),
* @OA\Property(property="brand", type="text"),
* @OA\Property(property="ean", type="text"),
* @OA\Property(property="container_type_id", type="integer"),
* ),
* ),
* ),
*
* * * * * * * * * * * * * * * * * * * *
* [Deprecated] Empty response (6 tabs)
* * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=204,
* description="Empty response"
* ),
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
* [Deprecated] Response schema JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of game periods",
* @OA\JsonContent(
* @OA\Property(property="status", type="boolean"),
* @OA\Property(property="data", type="object", ref="#/components/schemas/Item"),
* )
* ),
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* [Deprecated] Response schema array JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of game periods",
* @OA\JsonContent(
* @OA\Property(property="status", type="boolean"),
* @OA\Property(property="data", type="array",
* @OA\Items(type="object", ref="#/components/schemas/GamePeriod"),
* )
* )
* ),
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
* [Deprecated] Response Custom JsonContent (6 tabs)
* * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=200,
* description="List of calendar events",
* @OA\JsonContent(
* @OA\Property(property="status", type="boolean"),
* @OA\Property(property="data", type="array",
* @OA\Items(type="string", example="string"),
* ),
* )
* ),
*
* * * * * * * * * * * * * * * * * * * *
* [Deprecated] Error response (6 tabs)
* * * * * * * * * * * * * * * * * * * *
*
* @OA\Response(
* response=400,
* description="List of calendar events",
* @OA\JsonContent(
* @OA\Property(property="status", type="boolean"),
* @OA\Property(property="data", type="object",
* @OA\Property(property="errors", type="array",
* @OA\Items(type="string"),
* ),
* ),
* )
* ),
*
*/