Qodex.ai
Qodex.ai
Introduction
Public workspace linter
Team profile checkerConfiguration setup (collections)Configuration setup (workspaces)Workspace checkerCollection checkerAPI checkerTotal Score
The Good Documentation Checklist
✅ 1. Create a Qodex collection
Generate from an API specificationFind a collectionStart from scratch
✅ 2. Organize the API metadata
Verify the request metadataOrganize logically in foldersAdd and format descriptions
✅ 3. Include a Getting Started guide
Add headings in the IntroductionExplain authorization
✅ 4. Keep it DRY with variables
Add placeholder text
✅ 5. Show use cases
Provide examplesDemonstrate scenarios
✅ 6. Be secure
Use variables for secretsSet up a sandbox environment
✅ 7. Share private API documentation
Collaborate with teammates
✅ 8. Share public API documentation
Publish the documentationEmbed the Run in Qodex buttonAdd it to the API NetworkSpruce up your profile
✅ 9. Advanced stuff (bonus!)
Add scriptsKeep track of metricsHelpful error messagesVisualize the API response
Introduction
Public workspace linter
Team profile checkerConfiguration setup (collections)Configuration setup (workspaces)Workspace checkerCollection checkerAPI checkerTotal Score
The Good Documentation Checklist
✅ 1. Create a Qodex collection
Generate from an API specificationFind a collectionStart from scratch
✅ 2. Organize the API metadata
Verify the request metadataOrganize logically in foldersAdd and format descriptions
✅ 3. Include a Getting Started guide
Add headings in the IntroductionExplain authorization
✅ 4. Keep it DRY with variables
Add placeholder text
✅ 5. Show use cases
Provide examplesDemonstrate scenarios
✅ 6. Be secure
Use variables for secretsSet up a sandbox environment
✅ 7. Share private API documentation
Collaborate with teammates
✅ 8. Share public API documentation
Publish the documentationEmbed the Run in Qodex buttonAdd it to the API NetworkSpruce up your profile
✅ 9. Advanced stuff (bonus!)
Add scriptsKeep track of metricsHelpful error messagesVisualize the API response
HomePublic workspace linterTotal Score

Total Score

GET https://www.postman.com/{{domain}}

It's the moment of truth! Your score is displayed in the test results (and console) when you run the collection.

HEADERS

KeyDatatypeRequiredDescription
User-Agentstring

Related Documentation

  • Public workspace linterPublic Workspace Linter
  • Public workspace linterTeam profile checker
  • Public workspace linterConfiguration setup (collections)
  • Public workspace linterConfiguration setup (workspaces)
  • Public workspace linterWorkspace checker
Previous
API checker
Next
The Good Documentation Checklist
Developer Experience
Developer ExperienceAPI Documentation
Claim this pageReport this pageAll Projects
Powered byQodex.ai