writer icon indicating copy to clipboard operation
writer copied to clipboard

New Doc Support for PHP : OpenApi / Swagger

Open ap-coder opened this issue 3 years ago • 0 comments

Would you add a new type of doc for php specifically laravel.

https://swagger.io/

Here is an example in a php file.

https://github.com/zircote/swagger-php/blob/master/Examples/example-object/OpenApiSpec.php

There are no attempts to integrate this into AI yet so it would be a big plus to cover it with yours.

Here is a article of it being used in a laravel api written in php.

https://blog.quickadminpanel.com/laravel-api-documentation-with-openapiswagger/

Or is there a way to edit the template your phpstorm plugin uses and so I can add these to it.


/**
 * @OA\Tag(
 *     name="user",
 *     description="User related operations"
 * )
 * @OA\Info(
 *     version="1.0",
 *     title="Example for response examples value",
 *     description="Example info",
 *     @OA\Contact(name="Swagger API Team")
 * )
 * @OA\Server(
 *     url="https://example.localhost",
 *     description="API server"
 * )
 */
class OpenApiSpec {}

ap-coder avatar Feb 24 '22 19:02 ap-coder