The API Changelog
Subscribe
Sign in
Home
News
Opinion
Documentation
iPaaS
Archive
About
Documentation
Latest
Top
Discussions
Documenting Examples using OpenAPI
Is there any advantage in using OpenAPI to document examples?
Sep 2
•
Bruno Pedro
Share this post
Documenting Examples using OpenAPI
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Using OpenAPI to Document the API Operations You Consume
Can OpenAPI be a way to catalog and consume third-party API operations?
Aug 13
•
Bruno Pedro
Share this post
Using OpenAPI to Document the API Operations You Consume
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
4
How Documentation Affects API Quality
If quality depends on consumers' perception, how can API documentation influence it?
Jul 12
•
Bruno Pedro
2
Share this post
How Documentation Affects API Quality
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Fill the Gaps between API Consumer Lifecycle Stages
What is the role of documentation in helping consumers navigate their API lifecycle?
Jun 24
•
Bruno Pedro
1
Share this post
Fill the Gaps between API Consumer Lifecycle Stages
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Documenting API Workflows with Arazzo
Having the same source of truth for both machine- and human-readable API workflow documentation is possible.
Jun 6
•
Bruno Pedro
2
Share this post
Documenting API Workflows with Arazzo
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
How to Document Event-Driven API Message Payloads
Documenting event-driven payloads is necessary to promote healthy consumption.
May 13
•
Bruno Pedro
Share this post
How to Document Event-Driven API Message Payloads
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
API Documentation Consumes Attention
Developers consume API Documentation and, in turn, it consumes their attention.
Apr 29
•
Bruno Pedro
Share this post
API Documentation Consumes Attention
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Documenting API Changes
Should you document all your API changes?
Apr 12
•
Bruno Pedro
Share this post
Documenting API Changes
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Is AI the End of API Documentation?
How can you take advantage of AI to enhance your API documentation?
Mar 29
•
Bruno Pedro
3
Share this post
Is AI the End of API Documentation?
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
How Breaking Changes Affect API Documentation
API consumer experience is degraded whenever documentation diverges from reality
Mar 15
•
Bruno Pedro
Share this post
How Breaking Changes Affect API Documentation
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
1
Two Ways to Influence Business Growth with API Documentation
How can you drive business results with good API documentation?
Mar 1
•
Bruno Pedro
2
Share this post
Two Ways to Influence Business Growth with API Documentation
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Is API Documentation Marketing?
The parallel between the 4Ps marketing framework and API documentation
Feb 16
•
Bruno Pedro
3
Share this post
Is API Documentation Marketing?
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Share
Copy link
Facebook
Email
Note
Other
This site requires JavaScript to run correctly. Please
turn on JavaScript
or unblock scripts