[API] Replace Swagger with OpenAPI #15158
Merged
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
probot-autolabeler
bot
added
API
coldic3
force-pushed
the
feature/replace-swagger-with-open-api
branch
from
d7ba2e0
to
5d13875
Compare
Bunnyshell Preview Environment deletedAvailable commands:
|
coldic3
force-pushed
the
feature/replace-swagger-with-open-api
branch
from
5d13875
to
b7cb6ac
Compare
coldic3
force-pushed
the
feature/replace-swagger-with-open-api
branch
from
b7cb6ac
to
2554fd6
Compare
|
/bns:start |
jakubtobiasz
approved these changes
Jul 12, 2023
NoResponseMate
approved these changes
Jul 16, 2023
|
Any movement on this? We also encountered this problem in our project. Json and html versions of api docs being different is a headache, as is OpenApiFactory only applying to json, but not to html. |
jakubtobiasz
approved these changes
Jul 30, 2023
|
Thank you, @coldic3! |
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.
In this PR I do several things:
SwaggerUiActionthat overrides API Platform's one. It was used (if I see correctly) only to add a custom twig template. Thanks to the removal of overwritten action, we use OpenAPI instead of Swagger. I don't know how to override twig template in a bundle, so I do ittemplates/bundles. I think no one usesApiBundleseparately ;)Sylius\Bundle\ApiBundle\Swaggerand decorateapi_platform.openapi.factory.DocumentationModifierInterfacedo the same what normalizers were doing.