Using Postman to Explore the Triathlon API
An API expert explains why Postman Collections should be a default part of your API documentation, just like an OpenAPI definition should be a part of API docs.
Join the DZone community and get the full member experience.Join For Free
I’m taking time to showcase any API I come across who have published their OpenAPI definitions to GitHub like New York Times, Box, Stripe, SendGrid, Nexmo, and others have. I’m also taking the time to publish stories showcasing any API provider who similarly publishes Postman Collections as part of their API documentation. Next up on my list is the Triathlon API, who provides a pretty sophisticated API stack for managing triathlons around the world, complete with a list of Postman Collections for exploring and getting up and running with their API.
Much like Okta, which I wrote about last week, the Triathlon API has broken their Postman Collections into individual service collections and provides a nice list of them for easy access. Making it quick and easy to get up and running making calls to the API. Something that ALL API providers should be doing. Sorry, but Postman Collections should be a default part of your API documentation, just like an OpenAPI definition should the driver of your interactive API docs, and the rest of your API lifecycle.
Every provider should be maintaining their OpenAPI definitions, as well as Postman Collections on GitHub, and baking them into their API documentation. Your OpenAPI should be the central truth for your API operations, and then you can easily import it, and generate Postman Collections as you design, test, and evolve your API using the Postman development suite. I know there are many API providers who haven’t caught up to this approach to delivering API resources, but it is something they need to tune into and make the necessary shift in how you are delivering your resources.
In addition to regular stories like this on the blog, you will find me reaching out to individual API providers asking if they have an OpenAPI and/or Postman Collections. I’m personally invested in getting API providers to adopt their API definition formats. I want to see their APIs present in my API Stack work, as well as other API discovery projects I’m contributing to like Streamdata.io, Postman Network, APIs.Guru, and others. Making sure your APIs are discovered and making sure you are getting out of the way of your developers by baking API definitions into your API operations–it is just what you do in 2018.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.