Publishing documentation in Postman - Framework Patterns

Framework Mode - Publishing documentation

Folder Structure for Postman Documentation Publishing

postman-project/
├── collections/
│   └── api-collection.json       # Postman collection file with API requests
├── environments/
│   ├── dev.postman_environment.json  # Environment variables for dev
│   └── prod.postman_environment.json # Environment variables for prod
├── documentation/
│   └── published-docs/            # Folder for exported or generated docs
├── scripts/
│   ├── pre-request-scripts.js     # Optional scripts for requests
│   └── test-scripts.js            # Optional test scripts
├── postman.config.json            # Configuration for Postman CLI or Newman
└── README.md                      # Project overview and publishing instructions
    

Test Framework Layers for Postman Documentation Publishing

• Collections Layer: Contains API requests grouped logically. This is the source for documentation.
• Environment Layer: Holds environment-specific variables to run requests in different setups.
• Scripts Layer: Contains pre-request and test scripts to automate checks and setup.
• Documentation Layer: Stores generated or exported documentation files ready for publishing.
• Configuration Layer: Holds config files for Postman CLI tools or Newman to automate runs and doc generation.

Configuration Patterns for Publishing Documentation

• Environment Management: Use separate environment files for dev, staging, and prod to keep variables organized.
• Collection Versioning: Maintain versions of collections to track API changes and update docs accordingly.
• Postman CLI / Newman Config: Use postman.config.json or Newman CLI commands to automate collection runs and generate documentation.
• Documentation Export Settings: Configure export format (HTML, Markdown) and location in the documentation/published-docs folder.
• Credentials Handling: Store sensitive data in environment variables, never hardcode in collections or scripts.

Test Reporting and CI/CD Integration

• Automated Doc Generation: Integrate Newman or Postman CLI in CI pipelines (GitHub Actions, Jenkins) to generate docs on collection updates.
• Publish to Web: Use Postman public documentation or export HTML/Markdown to host on company docs site or GitHub Pages.
• Test Run Reports: Capture test results from Newman runs and attach to CI reports for visibility.
• Version Control: Store collections, environments, and docs in Git to track changes and enable rollback.

Best Practices for Publishing Documentation in Postman

1. Keep Collections Clean and Organized: Group requests logically and name them clearly for easy understanding.
2. Use Environment Variables: Avoid hardcoding values; use environments to switch contexts easily.
3. Automate Documentation Generation: Use Postman CLI or Newman in CI to keep docs up-to-date without manual effort.
4. Secure Sensitive Data: Never expose credentials in collections or public docs; use environment variables and secrets management.
5. Version Your Collections: Track API changes and update docs accordingly to avoid confusion.

Self Check

Where in this folder structure would you add a new environment file for testing the API in a staging environment?

Key Result

Organize Postman collections, environments, scripts, and configs to automate and publish up-to-date API documentation.

Practice

1. What is the main purpose of publishing documentation in Postman?

easy

A. To create new API endpoints

B. To run automated tests on APIs

C. To share API details clearly with others

D. To debug API requests

Solution

1. Step 1: Understand the purpose of documentation

   Documentation explains how an API works and helps others use it.

2. Step 2: Identify the role of publishing in Postman

   Publishing shares this documentation so others can access it easily.

3. Final Answer:

   To share API details clearly with others -> Option C

4. Quick Check:

   Publishing documentation = sharing API info [OK]

Hint: Publishing docs means sharing API info with others [OK]

Common Mistakes:

• Confusing publishing with testing APIs
• Thinking publishing creates API endpoints
• Assuming publishing is for debugging

2. Which menu in Postman do you use to publish documentation for a collection?

easy

A. History menu

B. Environment menu

C. Runner menu

D. Collection menu

Solution

1. Step 1: Locate where collections are managed

   Collections hold API requests and their details in Postman.

2. Step 2: Identify the menu for publishing docs

   The Collection menu provides options to publish documentation for that collection.

3. Final Answer:

   Collection menu -> Option D

4. Quick Check:

   Publish docs from Collection menu [OK]

Hint: Publish docs from the Collection menu in Postman [OK]

Common Mistakes:

• Choosing Environment menu which manages variables
• Selecting History menu which shows past requests
• Using Runner menu meant for running tests

3. If you update your Postman collection after publishing documentation, what happens to the published docs?

medium

A. They update automatically to reflect changes

B. They become read-only and cannot be changed

C. They get deleted and need republishing

D. They remain unchanged until manually updated

Solution

1. Step 1: Understand the link between collection and docs

   Published docs are connected to the collection's current state.

2. Step 2: Identify behavior on collection update

   When the collection changes, the published docs update automatically to stay current.

3. Final Answer:

   They update automatically to reflect changes -> Option A

4. Quick Check:

   Docs auto-update with collection changes [OK]

Hint: Published docs auto-update when collection changes [OK]

Common Mistakes:

• Thinking docs stay static after publishing
• Believing docs get deleted on update
• Assuming docs become read-only

4. You tried to publish documentation but the option is greyed out in Postman. What is the most likely cause?

medium

A. You have not selected a collection

B. Your collection has no requests

C. You have not logged into Postman

D. Your internet connection is offline

Solution

1. Step 1: Check requirements for publishing docs

   Publishing requires a collection with at least one request to document.

2. Step 2: Analyze why option is disabled

   If the collection is empty (no requests), the publish option is disabled (greyed out).

3. Final Answer:

   Your collection has no requests -> Option B

4. Quick Check:

   Empty collection disables publish option [OK]

Hint: Ensure collection has requests before publishing docs [OK]

Common Mistakes:

• Assuming internet or login issues cause greyed option
• Not checking if collection is empty
• Confusing selection with collection content

5. You want to share your API documentation publicly but only for specific team members. Which Postman feature should you use when publishing documentation?

hard

A. Set documentation visibility to 'Team' instead of 'Public'

B. Publish documentation without any visibility settings

C. Export collection and email it manually

D. Use environment variables to restrict access

Solution

1. Step 1: Understand visibility options in Postman docs

   Postman allows setting documentation visibility to Public, Team, or Private.

2. Step 2: Choose correct visibility for sharing with team only

   Setting visibility to 'Team' restricts access to team members only, not public.

3. Final Answer:

   Set documentation visibility to 'Team' instead of 'Public' -> Option A

4. Quick Check:

   Use 'Team' visibility to share docs with team only [OK]

Hint: Use 'Team' visibility to limit doc access to team members [OK]

Common Mistakes:

• Publishing docs as Public when private sharing needed
• Relying on environment variables for access control
• Exporting collections instead of publishing docs