The Good Documentation Checklist

✅ 1. Create a Qodex collection

Generate from an API specification Find a collection Start from scratch

✅ 2. Organize the API metadata

Verify the request metadata Organize logically in folders Add and format descriptions

✅ 3. Include a Getting Started guide

Add headings in the Introduction Explain authorization

✅ 4. Keep it DRY with variables

Add placeholder text

✅ 5. Show use cases

Provide examples Demonstrate scenarios

✅ 6. Be secure

Use variables for secrets Set up a sandbox environment

✅ 7. Share private API documentation

Collaborate with teammates

✅ 8. Share public API documentation

Publish the documentation Embed the Run in Qodex button Add it to the API Network Spruce up your profile

✅ 9. Advanced stuff (bonus!)

Add scripts Keep track of metrics Helpful error messages Visualize the API response

Public SOAP APIs

NumberToDollars

NumberToDollars Subtract

List of Continents by Name

International Phone Code for a Country Copy

List of Currencies by Name

List of Languages by Name

Book ISBN Numbers

Is Valid ISBN10 Number

Farenheit to Celsius Conversion

Day 10: Mock services

Submit your solution

Day 22: Public profile

planets species

Submit your solution

Day 26: Parse HTML response

Parse HTML response

Submit your solution

Day 05: Variables

collection variable global variable

Submit your solution

Day 24: Using libraries

Using libraries

random chuck norris moments in time

Submit your solution

Submit your solution

Day 23: Data files

Submit your solution

Postman OData Tutorial

01. Read the service root 02. Read the service metadata 03. Read an entity set 04. Get a single entity from an entity set 05. Get a primitive property 06. Get the raw value of a primitive property 07. Navigate to related entities 08. Filter a collection 09. Filter on enumeration properties 10. Filter on nested structures 11. Filter using logic operators 12. Filter using any/all operators 20. Casting types 14. Sort a collection 15. Client-side paging 16. Counting the elements in a collection 17. Expand related entities 18. Select the properties 19. Request full metadata 21. Create an entity 22. Delete an entity 23. Update an entity 24. Invoke an unbound function 25. Invoke a bound function 26. Invoke a bound action

Day 17: Visualizations

Submit your solution

Day 16: Pagination

Submit your solution

Day 27: Scenario testing

Scenario testing-Set up

User create endpoint

Scenario testing-Create new movie

Movie create endpoint Movie delete endpoint Movie read endpoint Movie update endpoint All movies read endpoint

Submit your solution

get realm Access Token Get the List

All Collections Single Collection Create Collection Update Collection Delete Collection Create a Fork Merge a Fork

All Environments Single Environment Create Environment Update Environment Delete Environment

All Mocks Single Mock Create Mock Update Mock Delete Mock Publish Mock Unpublish Mock

All Monitors Single Monitor Create Monitor Update Monitor Delete Monitor Run a Monitor

All workspaces Single workspace Create Workspace Update Workspace Delete Workspace

Import external API specification Import exported data

API-API Version

Create API Version Update an API Version Delete an API Version Get an API Version Get All API Versions

Create Schema Update Schema Get Schema Create collection from schema

Get linked relations Get documentation relations Get environment relations Get test suite relations Get contract test relations Get integration test relations Get monitor relations Create relations Sync relations with schema

Create API Update an API Delete an API Get all APIs Single API

Public REST APIs

Cat Facts Dog Breeds Pet Food Facts

Anime-Studio Ghibli

Films People Locations Species Vehicles

Barcodes-Open Food Facts

Biking Incidents

Books-Open Library

Book Covers Search

Makes of Cars Car Manufacturers

Church-Liturgical Calendar

Today Tomorrow Yesterday

Jewish Calendar Shabbat Times

Cryptocurrency-Coindesk

Current Bitcoin Price

Cryptocurrency-Cryptonator

Simple Ticker Complete Ticker

Domains-DomainsDB

Game of Thrones

Characters Books Houses

Gender-Genderiz.io

Gender Detector

IP Address-Ipify

IP Adress Lookup

IP Address-IP2Country

Associate IP Address with Country

Jobs-Workforce Data Initiative

Random Joke Dad Jokes Chuic Norris Joke

Historical American Newspapers

Zip Code Lookup

Ron Swanson Quotes

Refuge Restrooms

Latest SpaceX Launch

Sunrise and Sunset

Random Taco Recipes

Text-SHOUTCLOUD

ALL CAPS AS A SERVICE

Random Trivia Question

University Search

Website Breaches

Day 02: Collections and environments

Collections and environments

POST raw text GET with query params

Submit your solution

Day 21: Versioning

Submit your solution

submit collection submit API version

Day 15: Write to file

Submit your solution

Day 11: Monitoring

should I water the plants?water the plants

Submit your solution

Day 01: Fork a collection

Fork a collection

Submit your solution

Day 00: Pre-requisites

Email notification

Day 04: Authorization

All Collections - auth helper

Submit your solution

Day 18: API specifications

Submit your solution

submit collection submit api

Day 28: UI testing

response time lighthouse

Submit your solution

Day 19: GraphQL

Submit your solution

Day 29: Webhooks

Trigger Webhook echo Create Webhook

Submit your solution

Markdown in API Documentation

Multi-request loop

Get ID list 2nd POST request 3rd POST request

Day 30: Submit a pull request

get leaderboard

Postman Collection (from GraphQL)

Day 09: Scripting

get random user echo the user

Submit your solution

Day 07: Debugging

Submit your solution

Day 25: Dynamic request bodies

Dynamic request bodies

Submit your solution

Submit your solution

Spotify Playlist Generator

Get Auth Key Get Artist Get Related Artists Create a Playlist Get Artist Top Tracks Add Tracks to Playlist

Day 12: Postman API

get single collection get single environment get single workspace

Submit your solution

Day 08: Run a collection

Run a collection

get random user get french user

Submit your solution

Day 20: Documentation

get random user

Submit your solution

Day 03: Add request details

Add request details

Submit your solution

Unbreakable API Lite

Customer delete endpoint Customer read endpoint Customer create endpoint Customer update endpoint All customers read endpoint

Employee delete endpoint Employee read endpoint Employee update endpoint All employees read endpoint

Inventory item delete endpoint Inventory item read endpoint Inventory item create endpoint All inventory read endpoint

Movie delete endpoint Movie read endpoint Movie create endpoint Movie update endpoint All movies read endpoint

api-rentals-current

Current rental read endpoint All current rentals read endpoint

Rental rent endpoint Rental return endpoint

User ID endpoint User role endpoint

User create endpoint User authentication endpoint

The Good Documentation Checklist

✅ 1. Create a Qodex collection

Generate from an API specification Find a collection Start from scratch

✅ 2. Organize the API metadata

Verify the request metadata Organize logically in folders Add and format descriptions

✅ 3. Include a Getting Started guide

Add headings in the Introduction Explain authorization

✅ 4. Keep it DRY with variables

Add placeholder text

✅ 5. Show use cases

Provide examples Demonstrate scenarios

✅ 6. Be secure

Use variables for secrets Set up a sandbox environment

✅ 7. Share private API documentation

Collaborate with teammates

✅ 8. Share public API documentation

Publish the documentation Embed the Run in Qodex button Add it to the API Network Spruce up your profile

✅ 9. Advanced stuff (bonus!)

Add scripts Keep track of metrics Helpful error messages Visualize the API response

Public SOAP APIs

NumberToDollars

NumberToDollars Subtract

List of Continents by Name

International Phone Code for a Country Copy

List of Currencies by Name

List of Languages by Name

Book ISBN Numbers

Is Valid ISBN10 Number

Farenheit to Celsius Conversion

Day 10: Mock services

Submit your solution

Day 22: Public profile

planets species

Submit your solution

Day 26: Parse HTML response

Parse HTML response

Submit your solution

Day 05: Variables

collection variable global variable

Submit your solution

Day 24: Using libraries

Using libraries

random chuck norris moments in time

Submit your solution

Submit your solution

Day 23: Data files

Submit your solution

Postman OData Tutorial

01. Read the service root 02. Read the service metadata 03. Read an entity set 04. Get a single entity from an entity set 05. Get a primitive property 06. Get the raw value of a primitive property 07. Navigate to related entities 08. Filter a collection 09. Filter on enumeration properties 10. Filter on nested structures 11. Filter using logic operators 12. Filter using any/all operators 20. Casting types 14. Sort a collection 15. Client-side paging 16. Counting the elements in a collection 17. Expand related entities 18. Select the properties 19. Request full metadata 21. Create an entity 22. Delete an entity 23. Update an entity 24. Invoke an unbound function 25. Invoke a bound function 26. Invoke a bound action

Day 17: Visualizations

Submit your solution

Day 16: Pagination

Submit your solution

Day 27: Scenario testing

Scenario testing-Set up

User create endpoint

Scenario testing-Create new movie

Movie create endpoint Movie delete endpoint Movie read endpoint Movie update endpoint All movies read endpoint

Submit your solution

get realm Access Token Get the List

All Collections Single Collection Create Collection Update Collection Delete Collection Create a Fork Merge a Fork

All Environments Single Environment Create Environment Update Environment Delete Environment

All Mocks Single Mock Create Mock Update Mock Delete Mock Publish Mock Unpublish Mock

All Monitors Single Monitor Create Monitor Update Monitor Delete Monitor Run a Monitor

All workspaces Single workspace Create Workspace Update Workspace Delete Workspace

Import external API specification Import exported data

API-API Version

Create API Version Update an API Version Delete an API Version Get an API Version Get All API Versions

Create Schema Update Schema Get Schema Create collection from schema

Get linked relations Get documentation relations Get environment relations Get test suite relations Get contract test relations Get integration test relations Get monitor relations Create relations Sync relations with schema

Create API Update an API Delete an API Get all APIs Single API

Public REST APIs

Cat Facts Dog Breeds Pet Food Facts

Anime-Studio Ghibli

Films People Locations Species Vehicles

Barcodes-Open Food Facts

Biking Incidents

Books-Open Library

Book Covers Search

Makes of Cars Car Manufacturers

Church-Liturgical Calendar

Today Tomorrow Yesterday

Jewish Calendar Shabbat Times

Cryptocurrency-Coindesk

Current Bitcoin Price

Cryptocurrency-Cryptonator

Simple Ticker Complete Ticker

Domains-DomainsDB

Game of Thrones

Characters Books Houses

Gender-Genderiz.io

Gender Detector

IP Address-Ipify

IP Adress Lookup

IP Address-IP2Country

Associate IP Address with Country

Jobs-Workforce Data Initiative

Random Joke Dad Jokes Chuic Norris Joke

Historical American Newspapers

Zip Code Lookup

Ron Swanson Quotes

Refuge Restrooms

Latest SpaceX Launch

Sunrise and Sunset

Random Taco Recipes

Text-SHOUTCLOUD

ALL CAPS AS A SERVICE

Random Trivia Question

University Search

Website Breaches

Day 02: Collections and environments

Collections and environments

POST raw text GET with query params

Submit your solution

Day 21: Versioning

Submit your solution

submit collection submit API version

Day 15: Write to file

Submit your solution

Day 11: Monitoring

should I water the plants?water the plants

Submit your solution

Day 01: Fork a collection

Fork a collection

Submit your solution

Day 00: Pre-requisites

Email notification

Day 04: Authorization

All Collections - auth helper

Submit your solution

Day 18: API specifications

Submit your solution

submit collection submit api

Day 28: UI testing

response time lighthouse

Submit your solution

Day 19: GraphQL

Submit your solution

Day 29: Webhooks

Trigger Webhook echo Create Webhook

Submit your solution

Markdown in API Documentation

Multi-request loop

Get ID list 2nd POST request 3rd POST request

Day 30: Submit a pull request

get leaderboard

Postman Collection (from GraphQL)

Day 09: Scripting

get random user echo the user

Submit your solution

Day 07: Debugging

Submit your solution

Day 25: Dynamic request bodies

Dynamic request bodies

Submit your solution

Submit your solution

Spotify Playlist Generator

Get Auth Key Get Artist Get Related Artists Create a Playlist Get Artist Top Tracks Add Tracks to Playlist

Day 12: Postman API

get single collection get single environment get single workspace

Submit your solution

Day 08: Run a collection

Run a collection

get random user get french user

Submit your solution

Day 20: Documentation

get random user

Submit your solution

Day 03: Add request details

Add request details

Submit your solution

Unbreakable API Lite

Customer delete endpoint Customer read endpoint Customer create endpoint Customer update endpoint All customers read endpoint

Employee delete endpoint Employee read endpoint Employee update endpoint All employees read endpoint

Inventory item delete endpoint Inventory item read endpoint Inventory item create endpoint All inventory read endpoint

Movie delete endpoint Movie read endpoint Movie create endpoint Movie update endpoint All movies read endpoint

api-rentals-current

Current rental read endpoint All current rentals read endpoint

Rental rent endpoint Rental return endpoint

User ID endpoint User role endpoint

User create endpoint User authentication endpoint

Home Day 09: ScriptingSubmit your solution

Submit your solution

Number of APIs: 1

submit GET https://api.getpostman.com/collections/4454846-162496a0-61b2-439a-82d2-bf5db789439b