Automate API documentation #8870
jonasraoni
started this conversation in
Proposals
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Describe the bug
Once the #7698 is complete, we should replace the current API documentation approach (see https://github.com/pkp/pkp-lib/blob/3a8efd4f8b8fd195e13c46542d7785e158f947e9/tools/buildSwagger.php) by something more automated, probably based on PHPDoc/annotations.
The current documentation also doesn't honor the user expectations (see #8945).
Benefits:
Options
At this moment, this seems to be by far the most popular Laravel based project: https://github.com/DarkaOnLine/L5-Swagger, perhaps the scenario will be different later.
Beta Was this translation helpful? Give feedback.
All reactions