Four tips for better collections in API development

Posted on Wednesday, March 28, 2018 by RICHARD HARRIS, Executive Editor

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.

More App Developer News

Tether QVAC SDK Powers AI Across Devices and Platforms

APAC 5G expansion to fuel 347B mobile market by 2030

How AI is causing app litter everywhere

The App Economy Is Thriving

NIKKE 3.5 anniversary update livestream coming soon

New AI tool targets early dementia detection

Jentic launch gives AI agents api access

Experts warn ai-generated health content risks misinterpretation without human oversight

Ludo.ai Unveils API and MCP Beta to Power AI Game Asset Pipelines

AccuWeather Launches ChatGPT Integration for Live Weather Updates

Stop Using Business Jargon: 5 Ways Buzzwords Damage Job Performance

IT spending rises as banks balance legacy and innovation

Tech hiring slumps as Software Developer job postings fall

AI is becoming more widespread in collaboration tools

FCC prohibits new foreign router models citing critical infrastructure risks

ChatGPT Carbon Footprint Matches 1.3 Million Cars Report Finds

Lens Launches MCP Server to Connect AI Coding Assistants with Kubernetes

Accelerating corporate ai investment returns

Enviromates tech startup launches global participation platform

Private Repository Secures the AI-driven Development Boom

UK Fintech Platform Enviromates Connects Projects Brands and Consumers

Env Zero and CloudQuery Announce Merger

How Industrial AI Is Transforming Operations in 2026

AI generated work from managers is damaging trust among employees

Foresight Secures $25M to Bridge Infrastructure Execution Gap