[RFC] Add Swagger UI plugin for Joomla weblinks webservices#621
[RFC] Add Swagger UI plugin for Joomla weblinks webservices#621alikon wants to merge 5 commits intojoomla-extensions:5.x-devfrom alikon:swagger-ui
Conversation
|
Awesome work, I just tested it using the instructions but It didn't work, the plugin wasn't added so I couldn't turn it on to test, We should add this line in the |
|
thanks for checking, i didn't check the pkg_weblinks manifest file before now, dunno why it has not been added to the pkg_weblinks manifest file are you familiar with OpenAPI Specification (OAS) / Swagger ? |
|
No problem
Yes I've used it previously in some of my projects |
|
after some internal discussion we have agreed that this shouldn't be part of core weblink package |
Summary of Changes
This plugin lets you display interactive API docs in Joomla content using Swagger UI, triggered by the {swaggerui} tag.
it's based on The OpenAPI Specification (OAS)
https://www.openapis.org/what-is-openapi
Testing Instructions
enable the plugin
set the OpenAPI .yaml File
add {swaggerui} in the content.
Expected result
Actual result
N/A
Documentation Changes Required