Getting 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 |
|---|---|
| API Fundamentals | Core concepts: REST APIs, API security, different doc formats |
| API Types & Architectures | Different architectural patterns and protocols for building APIs |
| AI & APIs | Artificial intelligence concepts relevant to modern API documentation: generative AI, LLMs, machine learning |
| Tools & Technologies | API documentation tools: cURL, Postman, Git/GitHub, Markdown |
| Workflows & Methodologies | Project management approaches relevant to documentation: Agile, Document Development Life Cycle, usability testing |
| Frameworks & Strategy | Theoretical frameworks: cognitive dimensions of API usability, domain knowledge, developer personas |
| Writing Style | Communication approaches: rhetorical strategies, content strategy, tone considerations |
Navigation
Find Terms Quickly
- 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:
- Core definition: concept explanation
- Key details: relevant information, best practices, or technical specifications
- Examples: code snippets and/or technical writing scenarios
- Related terms: connections to other glossary term entries
- Sources: links to original references and/or further reading
Common Use Cases
| Scenario | Start here |
|---|---|
| New to API documentation | API → REST APIs → 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 your first 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 |