[Question]: is some solution to move all descriptive OA attributes from the route's method to another place (a separate class or method) ?

[upsetcode]

Version

5

Question

Is it possible to specify one attribute near the route method so that it points to an object that will contain all the attributes necessary to describe the route?

Goal: not to clutter the main code with attributes, so that the route method has only 2 attributes

For example:

#[Route(path: '/example', name: 'get-example', methods: [Request::METHOD_GET])]
#[OARouteSchema(ref: new NA\Model(type: ClassContainsExampleRouteSchema::class)))]
public function example():Response{...}

the class ClassContainsExampleRouteSchema contains all needed attributes for describes route (requests, response, tags, ...) OR it can use #[OA\Get(...)].

I know that I can describe everything in one attribute #[OA\Get(...)] on route, but it will contain too much code.

Perhaps there is some other solution to move all descriptive OA attributes from the route's method to another place (a separate class or method) ?

Additional context

No response

[DjordyKoert]

This is not really possible at the moment.

Currently the only way to kinda do this is by updating your bundle configuration and then referencing that in your attributes

https://symfony.com/bundles/NelmioApiDocBundle/current/configuration_reference.html#documentation

[TheoD02]

Personally, I use an approach similar to this: https://gist.github.com/TheoD02/ca7bc55ef449c11e49cb828ee60ce194
This isn’t exactly what you initially asked for, but it might be interesting for you

The goal is to provide a simple and straightforward way to declare APIs that covers about 90% of API use cases. This method is practical and easy to adopt. For more complex scenarios, such as multipart requests for file uploads or highly customized API endpoints, we can continue to by using a OA\Response.

This bundle is not published yet; it’s currently more of a proof of concept.

[upsetcode]

This is not really possible at the moment.

Currently the only way to kinda do this is by updating your bundle configuration and then referencing that in your attributes

https://symfony.com/bundles/NelmioApiDocBundle/current/configuration_reference.html#documentation

The task was solved. I created a new attribute with an argument pointing to the class containing OA attributes. Also slightly adjusted the logic of the OpenApiPhpDescriber class to handle this attribute.