kv4nt/yii2-oas3

Yii2 Open Api Swagger 3 integration

1.0.2 2022-11-09 11:33 UTC

Requires

• php: >=7.1
• ext-json: *
• bower-asset/swagger-ui: ^3.20
• rcnowak/yii2: 1.0
• zircote/swagger-php: ^3.0

MIT

• Simon Rodin

• json
• rest
• swagger
• yii2
• restfull
• open-api

README

Requirements

• PHP 7.1
• Yii2 Framework

Installation

The preferred way to install this wrapper is through composer.

php composer.phar require kv4nt/yii2-oas3 "*"

or

composer require kv4nt/yii2-oas3 "*"

or add to the require section of composer.json

"kv4nt/yii2-oas3" : "*"

Integration

Add action to web controller (for example SiteController.php):

public function actions()
{
    return [
        'api-docs' => [
            'class' => 'kv4nt\swagger\ViewAction',
            'apiJsonUrl' => \yii\helpers\Url::to(['/site/api-json'], true),
        ],
        'api-json' => [
            'class' => 'kv4nt\swagger\JsonAction',
            'dirs' => [
                Yii::getAlias('@api/modules/api/controllers'),
                Yii::getAlias('@api/modules/api/models'),
                Yii::getAlias('@api/models'),
            ],
        ],
    ];
}

Open Api Swagger 3 example annotation

Api server description

/**
 * @OA\Info(
 *   version="1.0",
 *   title="Application API",
 *   description="Server - Mobile app API",
 *   @OA\Contact(
 *     name="John Smith",
 *     email="[e-mail]",
 *   ),
 * ),
 * @OA\Server(
 *   url="https://example.com/api",
 *   description="main server",
 * )
 * @OA\Server(
 *   url="https://dev.example.com/api",
 *   description="dev server",
 * )
 */
 
class DefaultController extends Controller
{
...

Controller annotation

/**
 * @OA\Get(path="/",
 *   summary="Handshake",
 *   tags={"handshake"},
 *   @OA\Parameter(
 *     name="access-token",
 *     in="header",
 *     required=false,
 *     @OA\Schema(
 *       type="string"
 *     )
 *   ),
 *   @OA\Response(
 *     response=200,
 *     description="Returns Hello object",
 *     @OA\MediaType(
 *         mediaType="application/json",
 *         @OA\Schema(ref="#/components/schemas/Hello"),
 *     ),
 *   ),
 * )
 */
public function actionIndex()
{
... 

Model annotation

/**
 *@OA\Schema(
 *  schema="Hello",
 *  @OA\Property(
 *     property="message",
 *     type="string",
 *     description="Text message"
 *  ),
 *  @OA\Property(
 *     property="time",
 *     type="integer",
 *     description="Server current Unix time"
 *  ),
 *  @OA\Property(
 *     property="date",
 *     type="string",
 *     format="date-time",
 *     description="Server current date time"
 *  )
 *)
 */
class Hello extends Model
{
...

Donate

LICENSE

This curl wrapper is released under the MIT license.