Added swagger plugin #162
Merged
Added swagger plugin #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Linbreux
requested changes
May 28, 2024
There was a problem hiding this comment.
Thanks for the PR @DanZ-ix
It looks good. I made some remarks that should be changed. I also tried this
[[swagger https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/api-with-examples.json]]
And it did not show the block.
src/wikmd/plugins/swagger/swagger.py
Outdated
|
|
||
| injected_html = """ | ||
| <div id="{id}"></div> | ||
| <script src="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui-bundle.js" crossorigin></script> |
There was a problem hiding this comment.
Would be better to add it to web_dep and do it like this
By doing this we allow the local_mode to download all the remote files
src/wikmd/plugins/swagger/swagger.py
Outdated
|
|
||
| class Plugin: | ||
| def import_head(self): | ||
| return '<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css" />' |
|
Thx for your CRs, fixed all the problems, still doesnt work with two or more swagger blocks on one page, ill research this problem later, something with js scripts |
moves injected_html to a class member. By doing this, we don't need to use regex to replace the dependencies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added swagger plugin, that allows to insert a swagger block into a wiki page
Details
This plugin requires an URL with the .json openapi file. It provides such functions as authorization, sending requests, exploring api documentation and models.
You can test how it works with this swagger docs: https://petstore3.swagger.io/api/v3/openapi.json
I am not sure how it will work with two swagger blocks on one page, but i am going to add this functionality in future PRs.
Tested on windows (python 3.11) and Ubuntu Server (Docker build)
Checks
docs/<corresponding file>