Documentation Blog Posts From API Evangelist

These are the blog items I've written over the last decade when it comes to my Documentation resarch, providing the short form of my research across the API industry.


You can find all of the blog posts I have written over at the main API Evangelist site, these are mean to just be for providing easy access to what I've written when it comes to Documentation.

Curated Documentation News

These are the news items that I have curated during the monitoring of the API space that have some relevance to the Documentation conversation and I wanted to include in my research. I am using all of these links to better understand how the space is defining not just their APIs, but their schema, and other moving parts of their API operations.

Structured Data Files v5 now available in the DoubleClick Bid Manager API (09-03-2019)
Google Docs 'live edits' feature helps the visually impaired (08-21-2019)
How To Add Swagger (07-25-2019)
How Foursquare Succeeded In Managing Developers Documentation (02-18-2019)
Five Characteristics of Great API Documentation. (02-02-2019)
Workflow: Collaborative Documentation with Suggested Edits (02-01-2019)
How to build awesome and loved API documentation? (02-01-2019)
Combining API Metrics with API Error docs (01-29-2019)
Introducing API Error docs (01-29-2019)
Lets forget painful API documentation (01-29-2019)
Introducing the new SendBird Docs page (01-23-2019)
How good is your API documentation? (01-21-2019)
Setting Up Swagger In a Node.js Application (01-21-2019)
ApiaryUI (01-17-2019)
Exploring the API Explorer (01-14-2019)
Generate openapi documentation for your PHP API (01-03-2019)
Amazon Textract Extract text and data from virtually any document (amazon.com) (11-29-2018)
Postman to Wiki (11-16-2018)
The Importance of Context, Particularly When Documenting Software Architecture (11-15-2018)
Automating API Documentation (11-14-2018)
How I Broke (and Fixed) Our Documentation Site (10-29-2018)
API Explorer (10-29-2018)
Automate Your Documentation (10-16-2018)
Building Our Documentation Site on Platform OS Part 1: Information Architecture (10-11-2018)
The Anatomy of a Great Open Source Documentation: How to Document Your Projects on GitHub (09-20-2018)
Is Having A PDF for Your API Docs a Sin? (09-12-2018)
New Community Platform is a Win for Developers (09-10-2018)
Documentando RESTful APIs usando Spring REST Docs com Kotlin e Spring (09-04-2018)
Why you should write API Documentation (09-03-2018)
Why OCR for Receipts? (08-31-2018)
Accelerate API dev with documentation (08-30-2018)
Foundation Home Loans API goes live with OMS exclusive (08-30-2018)
How to Write Great API Documentation Every Time (08-27-2018)
Updated styling for new API Explorer (08-10-2018)
Announcing Enhancements to the Apigee Integrated Developer Portal (08-08-2018)
2 ways to auto (08-06-2018)
Stoplight v4.4 Release (08-03-2018)
PB Data Services Releases DIY Portal Data Append API Web Services (08-03-2018)
Swagger examined (part 1) How to document an API with incredible simplicity (08-03-2018)
ReadMe now supports OAS 3.0! (08-02-2018)
Manipulating scoped properties in Prototyped APIs in WSO2 API Manager (08-02-2018)
Need for better documentation (08-01-2018)
Use OCR To Organize Invoices (07-23-2018)
The Most Fundamental Secret to API Success (07-16-2018)
How Postman Can Improve Your API Documentation (07-11-2018)
Google Search Indexing API (06-28-2018)
Documenting RESTful APIs with Spring REST Docs (06-20-2018)
Unified ReadTheDocs Documentation (05-30-2018)
Do Your Microservices Matter? (05-25-2018)
Documenting Microservices in ReadMe (05-17-2018)
Podman API docs now available (05-14-2018)
Help improve our Azure docs! (05-14-2018)
Google Maps Embed (05-03-2018)
Evolving Embed (04-24-2018)
Writing a Documented API for Your Product With ASP.NET Web API (03-29-2018)
Create Flawless API Documentation with Stoplight Hubs (03-22-2018)
AWS Documentation is Now Open Source and on GitHub (03-13-2018)
Levelling Up API Documentation (03-07-2018)
7 Items No API Documentation Can Live Without (03-06-2018)
How to generate your api documentation with Postman in 20 minutes (03-01-2018)
Adopting OpenAPI to describe DNSimple API v2 (02-23-2018)
The Importance of API Documentation (02-21-2018)
Introducing ReadMe Glossary (02-20-2018)
vimeo/mill: A library for documenting a REST API with a small annotation DSL. (02-18-2018)
Barely Sufficient Documentation (02-09-2018)
API Its All About The Documentation (02-07-2018)
Docusaurus Easy to Maintain Open Source Documentation Websites (01-09-2018)
Whats the minimum documentation required for an API? (12-29-2017)
NODE (12-28-2017)
Importance of documenting your API (12-22-2017)
Wiring Microservices, Integration Microservices & APIs (12-04-2017)
Introducing Docker Community Leaders Formerly Known as Meetup Organizers (11-29-2017)
What Is Comprehensive Full API Lifecycle Management? (11-29-2017)
wicked.haufe.io (11-24-2017)
Testing an API Against its Documentation (11-23-2017)
Get To Know Your User for a Better API (11-21-2017)
Indispensable Things For Good API Documentation (11-21-2017)
A New Experience for Developer Documentation & Resources (11-20-2017)
Transforming Developer and Support Documentation with Docs Like Code (11-11-2017)
Datafiniti Completes The Last Phase of Elasticsearch Migration with Overhaul of Property API (11-09-2017)
API Hospitality: Welcoming Developers with Documentation (11-06-2017)
Is your software well documented? (11-05-2017)
OpenAPI for Documentation (11-04-2017)
Generate beautiful Swagger API documentation from Insomnia (11-03-2017)
DocuSign expands options and integrations to make tech easier for real estate agents (11-03-2017)
Standard practice (11-01-2017)
The Art and Personalization of The API Documentation Experience (10-31-2017)
Devhints TL;DR for developer documentation (10-28-2017)
APIs are everywhere, but documentation is wanting (10-28-2017)
A Fresh Update to our Platform Docs (10-27-2017)
Developers rejoice: Microsoft, Google, Mozilla are putting all their web API docs in one place (10-19-2017)
Microsoft concedes to Mozilla: Redmond will point web API docs at Moz Dev Network (10-18-2017)
StarWest and Advanced Automation in Your API Lifecycle (10-16-2017)
Postman survey shows that API documentation needs improvement (10-05-2017)
The Top 20 AWS IAM Documentation Pages so Far in 2017 (10-02-2017)
The Best API documentation EVER (09-29-2017)
The Ten Essentials for Good API Documentation An A List Apart Article (09-28-2017)
Best Practices and Tools for Documenting APIs (09-27-2017)
Introducing ReadMe Build (09-26-2017)
Enhance API Design and Documentation with New OpenAPI Specification 3.0 Support in SwaggerHub (09-22-2017)
Facebook Patent Uncertainty Means It's Time to Stop All GraphQL Development (09-21-2017)
Enhance API Design and Documentation with New OpenAPI Specification 3.0 Support in SwaggerHub (09-21-2017)
The Ten Essentials for Good API Documentation (09-20-2017)
Building an API Using API Documentation to Overcome 4 Key Challenges (09-19-2017)
Does GraphQL Reduce the Need for Documentation? (09-19-2017)
DevOps (09-18-2017)
Amazon Launches Enhanced Developer Site for the Alexa Voice Service (09-14-2017)
megalodoc/megalodoc: A 'scalable ', dev friendly alternative to SwaggerUI (09-11-2017)
Google publishes its documentation style guide for developers (09-07-2017)
Making the Google Developers documentation style guide public (09-06-2017)
An Introduction to Building TDD RESTful APIs with Koa 2, Mocha and Chai (09-03-2017)
launchany/mvd (09-01-2017)
API Documentation (09-01-2017)
Supporting Hypothesis (08-31-2017)
The Spy Pattern (08-30-2017)
Jekyll 3.5.2 is here (08-23-2017)
Tools and Practices for Documenting Microservices (08-23-2017)
Want to create better API documentation? Ask questions (08-23-2017)
Fetching Watermarked PDFs from Box using the Representations API, Python, and Flask (08-22-2017)
Context Aware Encoding (beta) (08-17-2017)
MaxxtonGroup/microdocs: Documentation that scales with your Microservices (08-17-2017)
Make your app architecture cloud (08-16-2017)
The API Cornucopia (08-15-2017)
Troubleshooting common Clover REST API error codes (08-14-2017)
API Best Practices (08-12-2017)
ActivePDF unveils server (08-10-2017)
Viewing Viewer Profile Information (08-10-2017)
This Excel training will turn you into a data whisperer (08-06-2017)
New Swagger Editor and UI Now Support Designing and Documenting OpenAPI Specification 3.0 APIs (08-03-2017)
Zynx Health Introduces FHIR (08-03-2017)
Documenting your API right in your code with Swagger (07-31-2017)
AdWords Scripts now integrated with Google Slides API (07-28-2017)
How to Build Documentation That Will Drive Sales (07-28-2017)
Documentation overhaul at Sheetlabs HQ (07-28-2017)
API Documentation an adventure with Google Drive (07-28-2017)
ActivePDF Unveils DocSight OCR, New Addition To PDF Product Suite (07-28-2017)
Reference for the Brightcove Live API (07-27-2017)
Kore Updates Kourier Platform with API Subscriptions Capabilities and Swagger Documentation (07-26-2017)
Quickly access API documentations of your favorite languages with these two applications (07-16-2017)
Using Hugo to Open Source Tyk documentation (07-13-2017)
Manage issues and pull requests with keyword updates (07-13-2017)
Brightcove Player Error Reference (07-13-2017)
How Akamai Improved Their API Documentation (07-12-2017)
Rust Security (07-12-2017)
Great API documentation requires code examples (07-07-2017)
Elements of Successful Software Documentation (07-06-2017)
Open all hours: Open Sourcing our Tyk documentation (06-29-2017)
Documentation as Code (06-21-2017)
Announcing New Documentation for Zoom REST API (06-19-2017)
Real Paths Toward Agile Documentation (06-12-2017)
Extending DocuSign for Salesforce: A Few Recipes for Success (06-09-2017)
API Document Generators Can Fall Woefully Short on Meeting Accessibility Guidelines (06-05-2017)
Free and Open Source API Documentation Tools (06-04-2017)
How to Document an API with Swagger UI (06-04-2017)
Documentation Agency (06-03-2017)
Documenting APIs with Swagger (06-02-2017)
Docsify A magical documentation site generator (06-01-2017)
How to Design Static REST API Documentation (05-29-2017)
Ecologists Are Drowning in Sea of Data. These Tools Could Help (05-27-2017)
API Documentation Browser 'Dash' Returns to iOS App Store As a Free Download (05-25-2017)
Tweet: Thinking about your API documentation? Excellent writeup by @zachflower on the killer components of API docs! https://t.co/RMXe79XpAu (05-11-2017)
Components of Killer API Docs (05-11-2017)
Components of Killer API Docs (05-11-2017)
The new Box Developer Console is now generally available to all developer accounts! (05-03-2017)
A curated list of free and open sources API documentation tools (05-02-2017)
Heres a great hack: borrow coding techniques for documentation (04-27-2017)
Elements of Helpful Code Documentation (04-17-2017)
API Docs by Request (04-13-2017)
The End of API Documentation As We Know It (04-12-2017)
Scribe Labs Google Docs Documentation Tool Released! (04-07-2017)
@readmeio: We've got Swagger! (03-13-2017)
Spring Boot RESTful API Documentation With Swagger 2 (03-06-2017)
Tweet: Convert #API documentation into formats such as Swagger, API Blueprint, and RAML from within Postman. Read the blog: https://t.co/S1KgaO39J4 (02-17-2017)
Tweet: Docs are up - https://t.co/CO7p6JsTWy. Your API could be covered by spec driven contract tests today - no excuses! https://t.co/C0U9knvkUf (02-15-2017)
Leveraging API Documentation for Customer Support (02-08-2017)
Box Overhauls its Developer Experience (02-08-2017)
Use Automatic API Documentation Testing To Supercharge API Growth (02-08-2017)
Documentation-Driven API Design (02-07-2017)
Documentation-Driven API Design (02-07-2017)
Designing Good Static REST API Documentation (02-06-2017)
HyperTrack docs have moved from Readme.io to GitBook (02-02-2017)
Agile documentation for your API-driven project (02-01-2017)
Announcing 2.0 Release of XML Documentation Add-On for Adobe Experience Manager (01-31-2017)
The Ultimate API Documentation Checklist (01-11-2017)
New Postman Pro Features API Monitoring, Documentation Generation, and Collaboration Tools (12-14-2016)
API Best Practices: Documentation (11-01-2016)
API Best Practices: Documentation (11-01-2016)
Searching CamelCased parameters in API documentation: how we handled it (10-21-2016)
Why machine readable documentation is key to your API?s success (10-10-2016)
An evaluation of auto-generated REST API Documentation UIs (10-07-2016)
Designing and documenting your API (10-06-2016)
How to create amazing API documentation (10-05-2016)
How to create amazing API documentation (10-05-2016)
New Stoplight Docs, a Stoplight API, RAML 1.0, 5x Faster API Docs (09-29-2016)
New Life for LoopBack Documentation (09-28-2016)
Announcing the new Docs Repo on GitHub! (09-23-2016)
Box Announces Four New Security and Governance APIs (09-22-2016)
Aglio: API Documentation Tool That Has It All ? JetRuby (09-21-2016)
Best Practices for Writing API Docs and Keeping Them Up To Date (09-19-2016)
3 Takeaways From Our First API Meetup (09-16-2016)
Implementing Swagger in your API documentation (09-08-2016)
Our Docs Are Now Hosted on GitHub (08-30-2016)
ASP.NET Web API Documentation using Swagger (08-29-2016)
A makeover for developer documentation (08-22-2016)
Share and document your API with Postman Cloud (08-18-2016)
What is the Difference Between API Documentation, Specification, and Definition? (08-16-2016)
Why You Should Let Robots Help You Write Your API Documentation (08-15-2016)
Web API documentation can be confusing to read (08-11-2016)
Install Gelato Integrations Directory (08-08-2016)
I hated writing documentation so I founded a company (08-08-2016)
Tweet: CloudFlare's JSON-powered Documentation Generator: https://t.co/p8Jh2Z0KMH https://t.co/hnSnOv759z (08-03-2016)
API Documentation "Almost" Done Right (07-22-2016)
Stack Documentation (07-21-2016)
Stack Overflow Documentation ? A crowdsourced developer documentation (07-21-2016)
Stack Overflow goes beyond Q&As and launches crowdsourced documentation (07-21-2016)
RESTful API Documentation SUCCESS Strategy (07-21-2016)
StackOverflow Documentation for proprietary web services (07-21-2016)
Introducing Stack Overflow Documentation Beta (07-20-2016)
Why Developers Write Horrible Documentation and How to Solve It (07-13-2016)
Presentation: We Need to Talk About Docs (07-12-2016)
How the Right Technical Writer Can Take API Docs from Good to Great (06-21-2016)
OpenGLAM Documentation updated (05-12-2016)
API Documentation Matters More than Performance and Functionality (05-06-2016)
API Views With OpenAPI Spec And Liquid (05-04-2016)
MSDN/TechNet Being Open Sourced as docs.microsoft.com (05-03-2016)
Introducing the Postmark API Explorer (04-28-2016)
Simplifying API documentation for a great first user experience (04-25-2016)
Get Around Dev Docs Faster (04-15-2016)
Jennifer Rondeau on the mix of grammar and tech in API documentation (04-13-2016)
Providing Specialized Views Of An API Surface Area Dynamically With OpenAPI Spec And Liquid (04-09-2016)
Further Simplifying My API Docs and Providing API Samples (03-29-2016)
Introducing the Google API Console (03-24-2016)
Tutorials from Twilio ? The new documentation experience from Twilio. (03-21-2016)
Further Simplifying My API Docs And Providing API Samples (03-17-2016)
API Documentation Needs to be Simpler (03-13-2016)
It Would Be Nice To Have Some Simpler Interactive API Documentation In Addition To What We Have Now (03-07-2016)
Docbox, an open source API documentation system (03-07-2016)
Best Practices in Action: The Best Buy API Query Builder (03-04-2016)
Meet the new Mapbox API documentation (03-04-2016)
Documentation First: A Recipe for API Success (02-27-2016)
Writing for Software Engineers: On Not Treating People as Code (02-25-2016)
REST API Documentation Using JAXRS-ANALYZER (02-20-2016)
Do You Publish API Docs Online for Availability to Third Party Developers? (02-18-2016)
I Am Liking The Modular Services That Are Delivering In Specific Areas Of API Life Cycle Like API-Docs.io (02-17-2016)
Spring REST Docs 1.1.0.M1 (02-16-2016)
RESTful Web API Help Documentation using Swagger UI and Swashbuckle (02-15-2016)
REST API Documentation Part 2 ? Swagger, RAML, and Open API (02-02-2016)
A New Open Source Interactive API Documentation From Folks Over At Lucybot (01-25-2016)
Building Your API Documentation Strategy For SUCCESS (01-22-2016)
SpringOne2GX 2015 Replay: Documenting RESTful APIs (01-21-2016)
Documenting RESTful APIs (01-19-2016)
10 Questions Your API Documentation Must Answer (01-12-2016)
Just The Best Parts Of The API Documentation Please (01-12-2016)
Bad API documentation: Why, and what you can do about it (01-08-2016)
Indix Product API Documentation Enhancements (01-07-2016)
Document-API-topia (API Days Paris 2015) (12-16-2015)
Moving Beyond API Reference Documentation (12-10-2015)
The Utopia of API Documentation (12-07-2015)
HTML documentation for your API (10-21-2015)
Why API Providers Must Offer Solid API Documentation (09-13-2015)
Our Brand New Docs (08-11-2015)
The Responsive Swagger Driven Version of Slate API Documentation I Was Looking For (06-26-2015)
We Should Be Generating Slate From Swagger So We Maintain A Machine Readable Core (06-25-2015)
Announcing New Docs for Keen IO (06-24-2015)
Better Living Through Documentation (05-27-2015)
Using Templates for Documentation Driven API Design (02-19-2015)
Why You Should Use Markdown for Your API Documentation (02-19-2015)
Dash Simplifies API Documentation for Mac, iOS Developers (02-18-2015)
Why We Open Sourced Our Docs and How We Did It (02-18-2015)

These are curated as part of my daily work to understand what is happening across the space, and I regularly use them to track on what has occurred overtime, and include them in my guides, whitepapers, and other outputs.

Featured Documentation Companies and Organizations

These are the organizations I come across in my research who are doing interesting things in the API space. They could be companies, institutions, government agencies, or any other type of organizational entity. My goal is to aggregate so I can stay in tune with what they are up to and how it impacts the API space.


Azure Monitor

Autoscale is a built-in feature of Cloud Services, Mobile Services, Virtual Machines, and Websites that helps applications perform their best when demand changes. Of course, performance means different things for different applications. Some apps are CPU-bound, others memory-bound. For example, you could have a web app that handles millions of requests during the day and none at night. Autoscale can scale your service by any of these—or by a custom metric you define.


Azure Activity Log Alerts API

  • Activity Log Alerts List By Subscription Id
  • Activity Log Alerts List By Resource Group
  • Activity Log Alerts Create Or Update
  • Activity Log Alerts Delete
  • Activity Log Alerts Get
  • Activity Log Alerts Update

MonitorManagementClient

  • Autoscale Settings List By Resource Group
  • Autoscale Settings Create Or Update
  • Autoscale Settings Delete
  • Autoscale Settings Get


Apiary

Apiary provides the leading API-First platform designed specifically to help companies accelerate and control the design, development, and documentation of APIs.



Postman

Postman is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide. Postman is an elegant, flexible tool used to build connected software via APIs — quickly, easily and accurately. 


Postman Echo

  • Hawk Auth
  • Basic Auth
  • Get Cookies
  • Delete Cookies
  • Set Cookies
  • Deflate Compressed Response
  • Delay Response
  • DELETE Request
  • DigestAuth Request
  • Get UTF8 Encoded Response
  • GET Request
  • GZip Compressed Response
  • Request Headers
  • OAuth1.0 Verify Signature
  • PATCH Request
  • POST Request
  • PUT Request
  • Response Headers
  • Response Status Code
  • Streamed Response

Other Documentation Companies and Organizations

These are additional companies who have APIs, but do not have as much detaila nd resources available to rank with the others.

REST United - Automated SDK Generation with easy-to-follow documentation and example code
ReadMe.io - Create beautiful product and API documentation with our developer friendly platform.
Gelato.io - A tool for creating and maintaining excellent Developer Portals and API or Technical Documentation
API Docs - Hosted API documentation for every OAS (Swagger) and RAML spec out there. Powered by Stoplight.io. Document, mock, test, and more, with the StopLight API Designer.
Cachet - The open source status page system
SDK BRIDGE -
Dexy - Dexy helps your code to speak for itself. Show off your code with beautiful syntax highlighting. Write examples and Dexy will run them, inserting the output into any document you wish. Everything is based on live code, so updating is easy, syntax errors blow up on you, not your users, and typos are a thing of the past. With Dexys smart caching, your code is only executed when it needs updating, saving you time while keeping your documents robust.
Apidox - Apidox is a free to use, open source application. Code released under the MIT license. Contact, support and error reporting on GitHub.
Read the Docs - Read the Docs simplifies technical documentation by automating building, versioning, and hosting for you. Build up-to-date documentation for the web, print, and offline use on every version control push automatically.
APIEmbed - Auto-generated code snippets in many programming languages for your website, blog or API documentation. Made with Love by Mashape.
DapperDox - Build the ultimate developer experience - Create rich, browsable reference documentation and guides for your APIs
OAS - oas A language-agnostic tool for documenting your API right from your code, generating an OpenAPI Spec, and sharing it via a URL.

Documentation Tooling

These are the open source tooling that I come across in my research who are doing interesting things in the API space. They could be companies, institutions, government agencies, or any other type of tool_anizational entity. My goal is to aggregate so I can stay in tune with what they are up to and how it impacts the API space.