Recently swaggerhub released the ability to create swagger definition - well at least a template from a REST call. So, of course I decided to see what it would do with an orchestration.
https://inspector.swagger.io/builder/builder is the site you can use to call your orchestration and get a nice swagger definition of the API.
Of course, nothing is free.If you want to export this definition to swagger, you need to make it public or your need to pay for a subscription. I decided to risk it, but it also seems that swagger leaves the entire request (including username and password) in the template - so you might want to get in there a remove it.
The other problem I found with swaggerhub (GDPR does not exist there?) is that I cannot seem to delete the definition.
I end up with:
swagger: '2.0'info: description: defaultDescription version: '0.1' title: defaultTitlepaths: /orchestrator/20180327_AddAddressBook: post: consumes: - application/json produces: - text/html parameters: - in: body name: body required: false schema: $ref: '#/definitions/Model0' x-examples: application/json: |- { "username":"SHANNONM", "password":"", "inputs" : [ { "name" : "inputAddressDescription", "value" : "Shannon Moire" }, { "name" : "inputAddressType", "value" : "E" }, { "name" : "inputLongAddressNumber", "value" : "45674564551" } ] } responses: '200': description: Definition generated from Swagger Inspectordefinitions: Model0: properties: username: type: string password: type: string inputs: type: array items: $ref: '#/definitions/Inputs' Inputs: properties: name: type: string value: type: string
As my definition.
It's not perfect, as the key:value pairs for the parameters mean something in JDE, so there might be some massage required - but a great start to creating swagger defs for orchestrations!
If you want to take a look at my definition, you can do so here:
We can all hope for a better described and easier way of enterprise real time integration!
No comments:
Post a Comment