Postman created documentation support

I created another thread asking how to add documentation that is rendered client side. In trying to figure out how to accomplish this, I noticed this documentation was created by postman. Since this is such a common format, it would be nice to have native support for it.

I pulled the initial http response for the url: https://apidocs.checkoutchamp.com

I noticed a prefetch link which provides the url for the collection data:
https://apidocs.checkoutchamp.com/api/collections/6575778/TzRVg6ny/?segregateAuth=true&versionTag=latest

This comes back as json, and indexing fails on it.

Nice find, do you know if the pre-fetch URL and the JSON response would be valid for all Postman generated API docs? I also struggled a lot with client-side rendered documentation - I think Spotlight generated ones have the same issue as well.

Just did a quick scan of the code. Looks like it is statically generated, so it should all be identical up until the generator changes. I wouldn’t trust the prefetch link though, as there are 2 of them.

My recommendation would be:

  1. Check generator meta tag, if it == Postman Documenter, then you know it is postman
  2. If so, take ownerId and publishedId meta tags
  3. Construct a url: [base]/[ownerId]/[publishedId]
  4. Take resulting json, and index it