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✅ 8. Share public API documentation

✅ 8. Share public API documentation

Number of APIs: 4

  1. Embed the Run in Qodex button GET https://api.twitter.com/2/tweets/1275828087666679809?tweet.fields=attachments,author_id,created_at,entities,geo,id,in_reply_to_user_id,lang,possibly_sensitive,referenced_tweets,source,text,withheld

  2. Publish the documentation POST https://ads-api.twitter.com/7/stats/jobs/accounts/your_ads_account_id?end_time=&entity=&entity_ids=&granularity=&metric_groups=&placement=&start_time=

  3. Add it to the API Network GET https://explore.postman.com/

  4. Spruce up your profile GET https://explore.postman.com/263615

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
Collaborate with teammates
Next
Publish the documentation
Developer Experience
Developer ExperienceAPI Documentation
Claim this pageReport this pageAll Projects
Powered byQodex.ai