Does goyave has swagger or any kinda api documentation feature in it? #232
-
|
I am curious if I can have any API documentation in goyave. |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
|
It used to. v4 had an unfinished open API generator that was discontinued with v5. In the v5 release notes, it is said:
The reason it has been dropped is because in a real-world medium-sized project, it is often preferred to maintain such documentation manually. A generator can only get you the basic route information (and at most the request validation) with so many missing pieces that you would end up writing more than half of it in annotations. The system gathering information from code comments was broken with go 1.18 (go-goyave/openapi3@7881a09). In that case, it is preferable to directly write this documentation in the OpenAPI yml spec files. This way you will get all the flexibility that OpenAPI can provide without the inconveniences brought by the generator. |
Beta Was this translation helpful? Give feedback.
It used to. v4 had an unfinished open API generator that was discontinued with v5.
In the v5 release notes, it is said:
The reason it has been dropped is because in a real-world medium-sized project, it is often preferred to maintain such documentation manually. A generator can only get you the basic route information (and at most the request validation) with so many missing pieces that you would end up writing more than half of it in annotations. The system gathering information from code comment…