Documentation

Documenting Examples using OpenAPI

Is there any advantage in using OpenAPI to document examples?

Sep 2 •

Using OpenAPI to Document the API Operations You Consume

Can OpenAPI be a way to catalog and consume third-party API operations?

Aug 13 •

How Documentation Affects API Quality

If quality depends on consumers' perception, how can API documentation influence it?

Jul 12 •

Fill the Gaps between API Consumer Lifecycle Stages

What is the role of documentation in helping consumers navigate their API lifecycle?

Jun 24 •

Documenting API Workflows with Arazzo

Having the same source of truth for both machine- and human-readable API workflow documentation is possible.

Jun 6 •

How to Document Event-Driven API Message Payloads

Documenting event-driven payloads is necessary to promote healthy consumption.

May 13 •

API Documentation Consumes Attention

Developers consume API Documentation and, in turn, it consumes their attention.

Apr 29 •

Documenting API Changes

Should you document all your API changes?

Apr 12 •

Is AI the End of API Documentation?

How can you take advantage of AI to enhance your API documentation?

Mar 29 •

How Breaking Changes Affect API Documentation

API consumer experience is degraded whenever documentation diverges from reality

Mar 15 •

Two Ways to Influence Business Growth with API Documentation

How can you drive business results with good API documentation?

Mar 1 •

Is API Documentation Marketing?

The parallel between the 4Ps marketing framework and API documentation

Feb 16 •

#nojs-banner { position: fixed; bottom: 0; left: 0; padding: 16px 16px 16px 32px; width: 100%; box-sizing: border-box; background: red; color: white; font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; font-size: 13px; line-height: 13px; } #nojs-banner a { color: inherit; text-decoration: underline; } This site requires JavaScript to run correctly. Please turn on JavaScript or unblock scripts