Survey of API doc sites
- Overview
- Overview for publishing API docs
- Survey of API doc sites
- Design patterns with API doc sites
- Docs-as-code tools
- More about Markdown
- Version control systems
- Static site generators
- Hosting and deployment options
- Hybrid documentation systems
- Which tool to choose for API docs — my recommendations
Topic 3 of 11
Rather than approach the topic of publishing prescriptively, let’s begin with some concrete examples and move towards the formulation of general principles. The following are nearly 100 openly accessible API doc sites that you can browse as a way to look at patterns and examples.
List of API doc sites
Browse a few of these documentation sites to get a sense of the variety, but also try to identify common patterns. In this list, I include not only impressively designed docs but also docs that look like they were created by a department intern just learning HTML. The variety in the list demonstrates the many options for publishing tools and approaches, as well as terminology. I first put this list together years ago, so I’ve removed APIs that have since shut down (such as AddThis and the ESPN API) and added some newer doc sites at the end. It seems that almost everyone does their API docs their own way, with their own site, branding, organization, and style.
- Shopgate API docs
- Google Places API docs
- X (formerly Twitter) API docs
- Flickr API docs
- Facebook’s Graph API docs
- YouTube Data API docs
- eBay API docs
- Amazon EC2 API docs
- Twilio API docs
- Last.fm API docs
- Azure Maps docs (successor to Bing Maps)
- gpodder.net Web Service docs
- Google App Engine docs
- Foursquare developer docs
- Walmart API docs
- Dropbox API docs
- Splunk API docs
- Revit API docs
- DocuSign API docs
- GeoNames web services docs
- Adsense API docs
- Box API docs
- LinkedIn API docs
- Instagram Platform docs
- Google Analytics Admin API docs
- Yelp API docs
- Concur API docs
- PayPal API docs
- Bitly API docs
- Callfire API docs
- Reddit API docs
- DonorsChoose API docs
- SendGrid API docs
- Mailchimp API docs
- Basecamp API docs
- NYTimes API docs
- USPS API docs
- National Weather Service API docs
- Evernote API docs
- Stripe API docs
- Parse API docs
- OpenSecrets API docs
- News API docs
- CTA Train Tracker API docs
- Mapbox API docs
- Crunchbase API docs
- Zendesk API docs
- Pushover API docs
- Pusher Channels client API docs
- Pingdom API docs
- Jive docs
- BigCommerce API docs
- Indivo API 2.0 docs
- Socrata API docs
- GitHub REST API docs
- Mailgun API docs
- Riot Games API docs
- Swiftype API docs
- Snipcart API docs
- Vimeo API docs
- Crowdsignal (formerly Polldaddy) API docs
- Gumroad API docs
- Formstack API docs
- Salesforce Connect REST API docs
- The Movie Database API docs
- SoundCloud API docs
- CouchDB docs
- Smart Home API (Amazon Alexa) docs
- Coinbase Developer Platform docs
- Shopify API docs
- Authorize.net API docs
- Tripadvisor Content API docs
- Pinterest API docs
- Spotify Web API docs
- Trello API docs
- Yext API docs
- Strava API docs
- Plaid API docs
- TheRundown API docs
- Zype API docs
- Edamam API docs
- Veracode docs
- SAP BusinessObjects REST API docs
- Dwolla API docs
- Slack Web API docs
- Discord developer docs
- Square API reference
- Adyen API Explorer
- Notion API docs
- Algolia Search REST API docs
- Cloudflare API docs
- OpenAI API reference
- Claude API docs
- Jira Cloud REST API docs
- Vercel REST API docs
- Resend API reference
- Supabase API docs
Sponsored
Activity: Look for common patterns in API doc sites
In this activity, identify common patterns in API documentation sites.
- Go to the list of API documentation sites.
- Select about three different APIs (choose any of those listed on the page).
-
Look for several patterns or commonalities among the API doc sites. For example, you might look for any of the following patterns:
- Structure and templates
- Seamless branding (between docs and the marketing site)
- Abundant code samples and syntax highlighting
- Lengthy pages
- API Interactivity (such as an API Explorer)
- Docs as code tooling
- Markdown versions of pages or an llms.txt file for AI tools
-
Note any non-patterns, such as the following:
- Translation
- Video tutorials
- Commenting features
- Multiple outputs by role
- Make some notes in an API log or journal (or share them in the comments below).
In the next section, we’ll look at Design patterns with API doc sites. From your notes, look to see if the patterns I highlight match the ones you observed in the API doc sites you analyzed.
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.