how to document php api with swagger

Famous Flatworm answered on July 6, 2022 Popularity 8/10 Helpfulness 5/10

answer how to document php api with swagger

how to document php api with swagger

Comment

1. Install with composer:#
> composer require --dev zircote/swagger-php

2. Update your code#
Add swagger-php annotations or attributes to your source code.

Annotations
Attributes
<?php

use OpenApi\Annotations as OA;

/**
 * @OA\Info(
 *     title="My First API",
 *     version="0.1"
 * )
 */
class OpenApi {}

class MyController {

    /**
     * @OA\Get(
     *     path="/api/data.json",
     *     @OA\Response(
     *         response="200",
     *         description="The data"
     *     )
     * )
     */
    public function getResource() {
        // ...
    }
}

3. Generate OpenAPI documentation#
> ./bin/openapi src -o openapi.yaml

4. Explore and interact with your API#
Use an OpenAPI tool like Swagger UI to explore and interact with your API.

Popularity 8/10 Helpfulness 5/10 Language php

Source: Grepper

Tags: api document php swagger

Link to this answer
Share Copy Link

Contributed on Jul 06 2022

Famous Flatworm

0 Answers Avg Quality 2/10

how to document php api with swagger

Contents

More Related Answers

how to document php api with swagger

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.