The Good Documentation Checklist

The Good Documentation Checklist integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Postman DevRel.

The Good Documentation Checklist | Developer Experience Workspace | API documentation

Visualize the API response

We want to see cases on a timeline, so lets make date the dimension, and plot counts of confirmed, deaths, and recovered cases.


cols

Let's limit it to just the US. Want to see another country, change this to the country code of your choice

where

Our desired charting library. Other available formats are `PLOTLY_BAR`, `PLOTLY_BOXPLOT`, `PLOTLY_BUBBLE`, `PLOTLY_HIST`, `PLOTLY_PIE`, `GCHARTS`

format

limit

Visualize the API response ✅ 9. Advanced stuff (bonus!) The Good Documentation Checklist integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Postman DevRel.

Visualize the API response ✅ 9. Advanced stuff (bonus!) The Good Documentation Checklist | Developer Experience Workspace | API documentation

✅ 9. Advanced stuff (bonus!)

✅ 9. Advanced stuff (bonus!) The Good Documentation Checklist integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Postman DevRel.

✅ 9. Advanced stuff (bonus!) The Good Documentation Checklist | Developer Experience Workspace | API documentation

<h2>Get Started</h2>

<p><strong>API publishers:</strong> follow these three steps to get started with a better developer experience for onboarding, educating, and inspiring your API consumers.</p>

<ol>
<li>Create good documentation with [The Good Documentation Checklist]</li>
<li>[Set Up Your First Public Workspace in 5 Easy Steps]</li>
<li>[Link Your Docs to the Public Workspace] for a Better Developer Experience</li>
</ol>

<h2>Examples of great public workspaces</h2>

<ul>
<li>[Mercedes-Benz automotive]</li>
<li>[Belvo open banking API for Latin America]</li>
<li>[ArcGIS Location Services]</li>
</ul>

<h2>Examples of great team profiles</h2>

<ul>
<li><p><a href="ArcGIS">Esri</a></p></li>
<li><p>[Meta]</p></li>
</ul>

<h2>Examples of custom environments</h2>

<p>Such as [pre-filled environments via the Run in Qodex button]</p>

<ul>
<li>MongoDB</li>
<li>Belvo</li>
</ul>

<h2>Examples of Run in Qodex button placement</h2>

<ul>
<li>[Infobip] bundles collection and environment in a workspace description</li>
<li><a href="https://developer.okta.com/docs/reference/Qodex-collections/">Okta</a> provides a button for each API</li>
<li><a href="https://developer.brex.com/docs/Qodex/#customers-using-Qodex">Brex</a> provides a button for each API</li>
</ul>

<h2>Additional resources</h2>

<ul>
<li>[Top 25 API Onboarding Experiences]</li>
<li>[Increasing Adoption of an API with a Public Workspace]</li>
<li>[Design your own style guide with this public workspace linter]</li>
</ul>

<h2>Video resources</h2>

<p>Don&#39;t feel like reading? Check out these videos.</p>

<ul>
<li><a href="https://youtu.be/XNVo9WkCoak">Documentation</a> video</li>
<li><a href="https://youtu.be/I10RCvMbPi0">Creating a Workspace</a> video</li>
<li><a href="https://youtu.be/Ud_rq-VwO4s">Checklist for a Great Team Profile</a> video</li>
<li><a href="https://youtu.be/DjGbMdqnY64">Public Workspaces</a> video</li>
<li><a href="https://youtu.be/LYDtomysuBw">Contributing to Public Workspaces</a> video</li>
<li><a href="https://youtu.be/2LDR93X0WIc">Public API Network</a> video</li>
<li><a href="https://youtu.be/6MSS8YgvFVA">Workspace Linter Using a Style Guide</a> video</li>
</ul>


Developer Experience

Github

Twitter

Developer Website

Developer Experience projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Postman DevRel.

Key	Datatype	Required	Description
cols	string		We want to see cases on a timeline, so lets make date the dimension, and plot counts of confirmed, deaths, and recovered cases.
where	string		Let's limit it to just the US. Want to see another country, change this to the country code of your choice
format	string		Our desired charting library. Other available formats are `PLOTLY_BAR`, `PLOTLY_BOXPLOT`, `PLOTLY_BUBBLE`, `PLOTLY_HIST`, `PLOTLY_PIE`, `GCHARTS`
limit	number		Limit results to 5000