Tools for documenting and mapping APIs with application's user interface for impact analysis
Tools for documenting and mapping APIs with application's user interface for impact analysis
I work on developing API services that internally call multiple micro-services
I was looking for a tool that could help me map public facing APIs with the application's user interface (application is available as native android/ios and PWA)
We do use tools like Swagger and NewRelic for internally maintaining API related details and documentation. However, I was trying to look up any tool(preferably open-source) that could help me map the api calls with the user interface
For example:
A Homepage Screen for the app with multiple buttons. Each button makes a REST API call. These REST APIs internally call micro services.
I would like to have a UI based tool where I could show the Homepage screen for the app(a screenshot) and then write APIs endpoints and routes associated to each button.
The reason I am looking to do this is because I believe this will make new people on the team(and external stakeholders) easier to read and refer to the application flow and how it is tied to the REST APIs. This will also make impact analysis easier when making changes to certain services/APIs
No, a sitemap is not what I am looking for
– BountyHunter
Aug 29 at 17:44
One idea... If you have a test automation framework in place (let's say Selenium WebDriver), you could take screen shots during your tests and document REST API somewhere. It's possible to automate a document creation this way with screens and API.
– Fabio Manzano
Aug 29 at 17:50
I could do that without an automation framework but the problem is maintaining that is going to need a lot of manual intervention and an additional skill set to keep updating such framework. What I am looking for is a tool already built to do this or anything that’s at least close
– BountyHunter
Aug 29 at 18:07
By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.
Are you looking for a sitemap?
– Fabio Manzano
Aug 29 at 17:40