Use files as endpoint description

[Norda-AD]

Scribe version

4.38.0

Your question

I have included some HTML content in my endpoint description with the use of docblock. I was trying to replace that with the Endpoint attribute to move the endpoint description to its own file. I had no luck as you could imagine.

The reason behind that is two folds:

1. I would like to include the same information to multiple endpoints. I want to comply with the DRY principle.
2. I would like to use some linters on the files to make sure they are properly formatted (not possible at the moment).

Do you think that this could be interesting for the future of scribe?

Thank you for your hard work!

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Hey, can you try writing your custom strategy for this? You could make your custom attribute like this:

#[EndpointFromFile(path: '...')]

And then a strategy to read the specified file. It's quite straightforward if you follow the examples in the repo. For example, the UseResponseAttributes strategy does basically this with the ResponseFromFile attribute.

[shalvah]

In fact, all you need is an attribute that will read the file. https://github.com/knuckleswtf/scribe/blob/v5/src/Attributes/ResponseFromFile.php

And then extend the PhpAttributeStrategy, specifying the attribute name, defining the extractFromAttributes method, and you're done.

[Norda-AD]

@shalvah Thank you for your answer. I've never thought of that. I'll try and I'll give you some feedback.

Keep up your nice work!