Sylius / ShopApiPlugin

Shop API for Sylius.
https://sylius.com
130 stars 89 forks source link

How to render Swagger Docs? #719

Open honigkuchenbaer opened 3 years ago

honigkuchenbaer commented 3 years ago

Hi. Is it somehow possible to render a Swagger Docs document out of this plugin?

I know that we can find such a document at https://app.swaggerhub.com/apis/Sylius/sylius-shop-api/1.0.0.

But for our clients we want to provide such Swagger docs on our own site at an URL-path like https://domain.com/shop-api/docs.

How to do that? Thanks for any hint (I could not find anything in current documentation about this question)

mamazu commented 3 years ago

Hello, the easiest solution to render the current version of the swagger definition as documentation is to go to editor.swagger.io and paste the content into the editor. But you are right we should definitely document it.