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
HomeThe Good Documentation Checklist✅ 9. Advanced stuff (bonus!)

✅ 9. Advanced stuff (bonus!)

Number of APIs: 4

  1. Add scripts GET https://api.twitter.com/2/tweets/:id

  2. Keep track of metrics GET https://api.kloudless.com/v1/accounts/me/storage/folders/root/contents

  3. Helpful error messages POST {{url}}/auth/token

  4. Visualize the API response GET https://covid19.richdataservices.com/rds/api/query/int/jhu_country/select?cols=date_stamp,cnt_confirmed,cnt_death,cnt_recovered&where=(iso3166_1=US)&format=amcharts&limit=5000

Related Documentation

  • The Good Documentation ChecklistThe Good Documentation Checklist 3
  • ✅ 1. Create a Qodex collection1 Create A Qodex Collection 2
  • ✅ 1. Create a Qodex collectionGenerate from an API specification
  • ✅ 1. Create a Qodex collectionFind a collection
  • ✅ 1. Create a Qodex collectionStart from scratch
Previous
Spruce up your profile
Next
Add scripts
Developer Experience
Developer ExperienceAPI Documentation
Claim this pageReport this pageAll Projects
Powered byQodex.ai