Swagger Helper for Yii2

Generate Swagger/OpenAPI annotations automatically for Yii2 PHP controllers directly inside VS Code.

Swagger Helper helps Yii2 developers generate Swagger (@OA) annotations faster with automatic detection of:

• Module name
• Controller action name
• Git author name
• GET and POST endpoints

Features

✅ Generate Swagger GET annotations
✅ Generate Swagger POST annotations
✅ Auto detect Yii2 module name
✅ Auto detect controller action name
✅ Auto use Git username as author
✅ Generate default parameters and responses
✅ Supports OpenAPI (@OA) annotations

Usage

Generate Swagger GET

1. Open a Yii2 controller file

Example:

public function actionGetNotes()
{
}

2. Put the cursor on the action method

3. Open Command Palette:

Ctrl + Shift + P

4. Run:

Generate Swagger GET

Swagger Helper will generate:

/**
 * @OA\Get(
 *     path="PATH",
 *     summary="summary",
 *     description="[Developer Name] [DATE] Description",
 *     tags={"Hakeemi"},
 *     security={{"authorization": {}, "WebToken": {}}},
 *     @OA\Parameter(
 *         name="Parameter Name",
 *         in="query",
 *         required=true,
 *         description="Parameter description",
 *         @OA\Schema(
 *             type="integer"
 *         )
 *     ),
 *     @OA\Response(response="200", description="Success"),
 *     @OA\Response(response="400", description="Bad Request")
 * )
 */

Generate Swagger POST

Run:

Generate Swagger POST

Swagger Helper will generate:

/**
 * @OA\Post(
 *     path="PATH",
 *     summary="summary",
 *     description="[Developer Name] [DATE] Description",
 *     tags={"Hakeemi"},
 *     security={{"authorization": {}, "WebToken": {}}},
 *     @OA\RequestBody(
 *         required=true,
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                     property="Parameter Name",
 *                     type="integer",
 *                     example=1
 *                 )
 *             )
 *         )
 *     ),
 *     @OA\Response(response="200", description="Success"),
 *     @OA\Response(response="400", description="Bad Request"),
 *     @OA\Response(response="500", description="Server Error")
 * )
 */

Screenshots

Before

After

Requirements

• Visual Studio Code
• PHP project
• Yii2 framework
• Swagger/OpenAPI annotations

Extension Commands

Marketplace

Install directly from VS Code Marketplace.

Search for:

Swagger Helper

Release Notes

0.0.1

• Initial release
• Swagger GET generator
• Swagger POST generator
• Auto module detection
• Auto Git author detection

Author

Hytham Alborini

License

MIT