The API Changelog

Home
Chat
News
Opinion
Documentation
iPaaS
Sponsors
Archive
About

Documentation

Three Elements of a Good API README
Sometimes, offering an API README is enough. What are the elements that make it good?
 • 
Bruno Pedro
Selectively Serving Your API Reference
What if you could automate the way you serve your API reference to different types of consumers?
 • 
Bruno Pedro
Documentation-driven API Design
Can you design an API just by writing plain documentation?
 • 
Bruno Pedro
1
Producer-Oriented API Documentation
If API documentation is so important to consumers, how can it also help producers succeed?
 • 
Bruno Pedro
Trying Is a Way to Learn How an API Works
What is better than reading API documentation? Can trying an API be a way to learn how it works?
 • 
Bruno Pedro
API Documentation for Machines
What are the elements that make API documentation easily consumable by a machine?
 • 
Bruno Pedro
Using OpenAPI Overlays to Differentiate Consumer Personas
Is it possible to have a single OpenAPI document that targets different consumer personas?
 • 
Bruno Pedro
An Interactive Approach to API Prototyping Using OpenAPI
Can OpenAPI be the source-of-truth for real-time API prototyping?
 • 
Bruno Pedro
Prototyping APIs with OpenAPI
How can OpenAPI be a tool for quick, low-code API prototyping?
 • 
Bruno Pedro
The Use of Symbology in API Documentation
What is the role of symbology in API Documentation?
 • 
Bruno Pedro
2
Documenting Examples using OpenAPI
Is there any advantage in using OpenAPI to document examples?
 • 
Bruno Pedro
1
Using OpenAPI to Document the API Operations You Consume
Can OpenAPI be a way to catalog and consume third-party API operations?
 • 
Bruno Pedro
4
© 2025 The API Changelog
Privacy ∙ Terms ∙ Collection notice
Start WritingGet the app
Substack is the home for great culture