1. Four tips for better collections in API development
3/28/2018 1:31:03 PM
Four tips for better collections in API development
Postman API,API Development,App APIs
https://appdevelopermagazine.com/images/news_images/Four-Tips-for-Better-Collections-in-API-Development-App-Developer-Magazine_tqiwpjtz.jpg
App Developer Magazine
Four tips for better collections in API development

Four tips for better collections in API development



Richard Harris Richard Harris in API Wednesday, March 28, 2018
19,109

API Development tips and tricks to make your collections the best that they can be from Postman.

Whether your collections are for testing or documentation, collections are a way for humans to collaborate. A good collection clearly describes the behavior and usage of your API. These 2 types of collections typically have a different audience, are written by different authors and will contain different content. For these reasons, it’s a good practice to maintain separate collections for testing and documentation.

Follow these four tips for best practices:

  • Stay clean and tidy: Use folders to group together related requests or demonstrate a specific workflow. Secondary folders can then be nested under primary folders.

  • Include a quickstart: Include a quickstart somewhere in the collection and include a table for any required variables.

  • Explain authorization: Be explicit about the process so developers can easily roll it into their own apps.

  • Stay up to date: After making changes, refresh the collection to be shared so users will be importing the latest version.

In a recent blog post by Postman, they describe in more detail the some ways that you can follow in order to make your collections the best.


Read more: http://blog.getpostman.com/2018/03/08/the-good-col...

Subscribe to App Developer Magazine

Become a subscriber of App Developer Magazine for just $5.99 a month and take advantage of all these perks.

MEMBERS GET ACCESS TO

  • - Exclusive content from leaders in the industry
  • - Q&A articles from industry leaders
  • - Tips and tricks from the most successful developers weekly
  • - Monthly issues, including all 90+ back-issues since 2012
  • - Event discounts and early-bird signups
  • - Gain insight from top achievers in the app store
  • - Learn what tools to use, what SDK's to use, and more

    Subscribe here