Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blueprint generate docs from route file annotations #1701

Open
webwisejordan opened this issue Jan 20, 2020 · 1 comment
Open

Blueprint generate docs from route file annotations #1701

webwisejordan opened this issue Jan 20, 2020 · 1 comment
Labels
doc-generation Blueprint Documentation Generation

Comments

@webwisejordan
Copy link

Q A
Bug? no
New Feature? no
Framework Lumen
Framework version 6.2
Package version 2.4
PHP version 7.2

Description

My API needs to support both REST and GraphQL, so I have two controllers - a gql controller where the /graphql endpoint directs to and a rest controller where everything else does. The purpose of these two controllers is to convert the incoming request into a generic request before forwarding to the service layer, and to convert the result back into the appropriate format in the response.

Therefore, I don't have controllers defined for each database entity with API interaction details annotated as in the example - instead I have them all in the rest routes file. Previously (on Lumen 5.6/Dingo 2.0.0-alpha1), this worked just fine. After updating to Lumen 6.2/Dingo 2.4, this no longer functions, and I get an output file with only the name/format.

Is there anyway to have blueprint scan the route file for annotations (it doesn't need to care about the routes or anything else, paths/etc. are all defined in the annotations themselves) instead of the entire collection of application controllers?

Thank you for any insight

@specialtactics
Copy link
Member

Hi

I am not sure how the doc generation work, and to be honest what you are describing is a very specific use case. Unfortunately the person who originally wrote them is not longer around.

@specialtactics specialtactics added the doc-generation Blueprint Documentation Generation label Jan 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-generation Blueprint Documentation Generation
Projects
None yet
Development

No branches or pull requests

2 participants