Whilst developing with this plugin, I tried to use it, to deploy the api through a gitlab pipeline. Since there are multiple different potential clients, the issue was, that I required both json and yaml, for different usecases. Additionally I wanted to deploy the generated ui as a static html website as well.
The issue is, that I could only choose one specific, lead to a lot of frustrations for the client developers.
This major change allows to do that.
Removed Parameters
The following properties have been removed without deprecation:
apiDocsUrl
outputFileName
These two have been moved "exports".
Added Parameters
exports: a list of specific things to export from the api documentation
baseUrl: The base url to the api documentation (for example http://localhost:8080), reducing the boilerplate in exports.
Background
Whilst developing with this plugin, I tried to use it, to deploy the api through a gitlab pipeline. Since there are multiple different potential clients, the issue was, that I required both json and yaml, for different usecases. Additionally I wanted to deploy the generated ui as a static html website as well.
The issue is, that I could only choose one specific, lead to a lot of frustrations for the client developers.
This major change allows to do that.
Removed Parameters
The following properties have been removed without deprecation:
These two have been moved "exports".
Added Parameters
Example usage:
This example would fetch multiple parts from the swagger api.
Risks
This is a breaking change. It is possible to make it not as breaking, but this would introduce a lot of complexity to maintain these legcy way.
Open Points: