dingo / dingo/api

Blueprint generate docs from route file annotations

Open
#1,701 1 comment 0 reactions 0 assignees View on GitHub
doc-generation
Dominant language
PHP
Stars
9.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

| 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.