Hello everyone,
I’m going to write an macro that will provide the possibility to show an Open API documentation based on a Json or Yaml with Swagger. The idea is to use the Swagger-UI project which bring everything needed to develop this.
For this macro the idea is to have 2 main possibility to inject the API description.
- We can put the Open API doc in Json or Yaml format in the macro content
- We can provide an URL which will provide the information in Json or Yaml format like http://petstore.swagger.io/v2/swagger.json Note that we can also use this way to store the Json file as a page attachment.
For the seconds part as the browser will send an external request it might be sometime needed to use a proxy (to work around the CORS issue), so a parameter named proxy with a boolean will give the possibility to use or not the proxy.
Maybe at some point I could also integrate the Swagger editor as an application.
For the naming I propose to name it swagger or swagger-open-api or maybe open-api-doc.
What do you think ?
Josué
3 posts - 2 participants