I'm able to figure out some API get pages for our test site. How should I share this information in a readable format with other technical staff? Something like out put page in readable format!
I'm a little unsure of your antecedent when you say "this information." Are you talking about the information on how you used the API or the information you obtained from the API? I'll answer it like it's the second one, but if you're talking about something else, please let us know.
What I would start with is talking to the people who you're going to disseminate the information to in an effort to see what would be most useful for them. It may very likely be a comma separated values (CSV) file that they can bring into Excel or another spreadsheet and manipulate.
That really depends on the API call that you're making, though. If you're fetching pages with content and they want the content, then they may want it in a Word document so it flows.
Most programming languages have tools to parse JSON, and many have libraries to produce CSV files. It really depends on what language you want to work with what you use. If you want to explore the data and see what you're getting before you fully develop the report, I use an online JSON to CSV converter. There are several, but it's a quick way to look at the data until you become more familiar with JSON.
Finally realize that most data or report would need to pull information from multiple APIs. This isn't always the case, but it often is. You'll also need to worry about pagination. If you're only getting 10 items, then you are almost certainly running into that issue.
Hi Peg Marge,
You didn't mention how you're currently getting the results. The easiest thing is to take the curl URL and put it in a browser, which will try to use the built-in devtools to format it.
From the command line I use a combination of NPM JSON and python pygments to format and colorize output, like this:
Of course, turning JSON into a human-readable format kind of defeats the purpose of a machine-readable syntax, but it does have its uses sometimes
Hope that helps!
Were you able to find an answer to your question? I am going to go ahead and mark this question as answered because there hasn't been any more activity in a while so I assume that you have the information that you need. If you still have a question about this or if you have information that you would like to share with the community, by all means, please do come back and leave a comment. Also, if this question has been answered by one of the previous replies, please feel free to mark that answer as correct.
Retrieving data ...