vodevel/api-doc-bundle-type-describer

Describer to the nelmio/api-doc-bundle using method signature (types)

v1.0.2 2023-11-18 07:35 UTC

Requires

• php: >=8.0
• nelmio/api-doc-bundle: ^3.0|^4.0

MIT

• Vodevel

• type
• swagger
• openapi
• nelmio
• api-doc-bundle
• describer

README

Describer to the nelmio/api-doc-bundle using method signature (types)

Install

composer require vodevel/api-doc-bundle-type-describer

Usage

Unfortunately, it doesn't work without a Tag attribute yet, don't forget to add it.

Replacing

class Controller {
    #[Route('api/example', methods: ['POST'])]
    #[RequestBody(content: new Model(type: ExampleRequest::class))]
    #[Response(
        response: 200,
        description: '',
        content: new Model(type: ExampleResponse::class),
    )]
    #[Tag(name: 'example')]
    public function exampleMethod(ExampleRequest $request): ExampleResponse {
        return new ExampleResponse();
    }
}

With

class Controller {
    #[Route('api/special', methods: ['POST'])]
    #[Tag(name: 'example')]
    public function exampleMethod(ExampleRequest $request): ExampleResponse {
        return new ExampleResponse();
    }
}

#[RequestBody]
class SpecialPointRequest {}

#[Response]
class SpecialPointResponse {}