Skip to content

[RFC] Add Swagger UI plugin for Joomla weblinks webservices#621

Closed
alikon wants to merge 5 commits intojoomla-extensions:5.x-devfrom
alikon:swagger-ui
Closed

[RFC] Add Swagger UI plugin for Joomla weblinks webservices#621
alikon wants to merge 5 commits intojoomla-extensions:5.x-devfrom
alikon:swagger-ui

Conversation

@alikon
Copy link
Copy Markdown
Collaborator

@alikon alikon commented Apr 25, 2025

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

image

Actual result

N/A

Documentation Changes Required

@alikon alikon changed the title Add Swagger UI plugin for Joomla weblinks webservices [RFC] Add Swagger UI plugin for Joomla weblinks webservices Apr 25, 2025
@alikon alikon marked this pull request as ready for review April 25, 2025 07:39
@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor

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,
However I debugged it and found the issue, in the src/administrator/manifests/packages/pkg_weblinks.xml

<file type="plugin" id="weblinks" group="content">plg_content_swaggerui.zip</file>

We should add this line in the <files>, when i tried adding this it worked as expected.
Please check and let me know if I'm missing something.

@alikon
Copy link
Copy Markdown
Collaborator Author

alikon commented Apr 26, 2025

thanks for checking, i didn't check the pkg_weblinks manifest file before now,
when locally i've runned .\vendor\bin\robo build i've only checked that plg_content_swaggerui zip file
has been added in the zip folder so i was able to install it directly ie. not thw whole pkg

dunno why it has not been added to the pkg_weblinks manifest file

are you familiar with OpenAPI Specification (OAS) / Swagger ?

@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor

No problem

are you familiar with OpenAPI Specification (OAS) / Swagger ?

Yes I've used it previously in some of my projects

@alikon
Copy link
Copy Markdown
Collaborator Author

alikon commented Apr 27, 2025

after some internal discussion we have agreed that this shouldn't be part of core weblink package
i'll move it in a separate github public repository
anyway
if google give us a slot for this project
this will be an important task to have a successfull project

@alikon
Copy link
Copy Markdown
Collaborator Author

alikon commented Apr 27, 2025

moved to https://github.com/alikon/testcom/tree/main/plugins/content/swaggerui

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants