we recently developed our first custom API based on a Process Flow, which will be an integration from an external platform to execute some GET and POST-actions in our application.
As we are used to have a Swagger (or other documentation) of an API on which we make an integration, we are wondering how we can achieve a good documentation for our own developed API's.
The way we build our API is like described by 2 posts by Anne Buit some while ago (
)
Is there something in the SF we could use for this, or any pest practices ?
Thanks
Best answer by poonam
Hi,
At the moment there is no automatic Swagger / OpenAPI documentation available for APIs built using custom protocol Process Flows.
Although Indicium does expose an OpenAPI specification, custom protocol process flows are not included in that document. So these APIs won’t show up automatically.
For now, documentation will need to be handled manually, for example by:
maintaining your own OpenAPI/Swagger file,
documenting endpoints and payloads in a wiki or portal,.
optionally hosting a Swagger UI based on that manual spec.
At the moment there is no automatic Swagger / OpenAPI documentation available for APIs built using custom protocol Process Flows.
Although Indicium does expose an OpenAPI specification, custom protocol process flows are not included in that document. So these APIs won’t show up automatically.
For now, documentation will need to be handled manually, for example by:
maintaining your own OpenAPI/Swagger file,
documenting endpoints and payloads in a wiki or portal,.
optionally hosting a Swagger UI based on that manual spec.
I expected something like that, but looking from integration perspective with external parties it would be very useful if we could make the documentation easy (as it will speed up development 😊)
Will think of a way how we could make it easy to generate this kind of reporting easier and will add an Idea if I have come up with a proposal.
