Get Started
From REST fundamentals to documentation best practices, API Docs Glossary is a comprehensive reference for anyone working with API documentation.
This glossary originated from coursework in the University of Washington's AI-Enhanced API Documentation certification program and is a living document - terms and definitions are regularly updated as the field evolves.
Glossary Structure
Explore terms across seven main categories:
| Category | What's Covered |
|---|---|
| Core Concepts | API Fundamentals, Documentation-Specific: API security, CRUD, HTTP, different doc formats |
| API Types & Architectures | Different architectural patterns and protocols for building APIs: event-driven, GraphQL, gRPC, microservices, REST, SOAP, Webhook, WebSocket |
| AI & APIs | Artificial intelligence concepts relevant to modern API documentation: AI bias, genAI, LLM, MCP server, training data |
| Tools & Technologies | Development Essentials, Documentation-Specific, Infrastructure & Platforms, Testing-Validation: cURL, Doc Detective, Postman, Git, Markdown, Vale |
| Workflows & Methodologies | Project management approaches: Agile, API docs testing, docs-as-code, docs-as-tests, usability testing |
| Frameworks & Strategy | Theoretical frameworks: audience analysis, Diátaxis, docs-as-ecosystem, domain knowledge, sales collateral |
| Writing Style | Communication paths: rhetorical approach, content strategy, tone considerations |
Navigation
Find Terms Fast
- Search: use the search bar in the top navigation to instantly find any term
- Alphabetical Index: browse the Quick Reference for a complete alphabetical list with brief definitions
- Browse by Topic: from fundamentals to modern frameworks, review terms across seven categories
Term Entry Structure
Each glossary entry includes:
- Definition: concept explanation
- Purpose: key features and/or relevance to API documentation
- Examples: code snippets and/or technical writing scenarios
- Related Terms: connections to other glossary term entries
- Sources: links to original references
Common Use Cases
| Scenario | Start here |
|---|---|
| New to API documentation | API → REST API → API reference topic |
| Learning OpenAPI Specification | OpenAPI Specification → JSON → YAML |
| Preparing for technical interviews | cognitive dimensions of API usability → end-user software engineer personas |
| Working on an API tutorial | API overview topic → market → rhetorical approach |
| Setting up documentation tooling | Git → GitHub → GitHub Desktop → Markdown |
| Reporting issues, suggesting improvements | Contribution Guide → Style Guide |