Documentation

Alternative Ways to Make Your APIs Discoverable

Make consumers happier by making it easier to find and use your APIs.

Jun 25 •

Can TypeSpec Be an Alternative to OpenAPI?

Switching from OpenAPI to TypeSpec might be a viable solution.

Jun 13 •

Referencing a Tutorial for Each OpenAPI Operation

The best place to teach people is where they go to learn.

May 28 •

How to Automate API Documentation

Can documentation be automatically updated whenever the API changes?

May 16 •

Adding Semantic Information to Your OpenAPI Description

Helping machines navigate your API results shouldn't be complicated.

Apr 25 •

Documenting API Governance

How do you document the processes behind API governance?

Apr 10 •

Three Meaningful API Metrics

How can you improve an API if you're not measuring its behavior?

Mar 21 •

Migrating from OpenAPI 3.0 to 3.1

If you think the OpenAPI 3.0 and 3.1 specifications are fully compatible, think again.

Mar 7 •

Three Elements of a Good API README

Sometimes, offering an API README is enough. What are the elements that make it good?

Feb 22 •

Selectively Serving Your API Reference

What if you could automate the way you serve your API reference to different types of consumers?

Feb 7 •

Documentation-driven API Design

Can you design an API just by writing plain documentation?

Jan 24 •

Producer-Oriented API Documentation

If API documentation is so important to consumers, how can it also help producers succeed?

Jan 10 •

#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