General
195 views
API Documentation
Quick Definition
Documentation describing API usage and integration
Full Definition
Comprehensive documentation describing how to use and integrate with an API.
Examples
Swagger, OpenAPI, Postman collections, interactive docs
Related Terms
api-design
openapi
More General Terms
Scrum
Agile framework using fixed-length sprints
Domain-Driven Design
Software approach centered on business domain logic
Kanban
Visual workflow management using boards
Documentation as Code
Applying dev practices to documentation management
Refactoring
Restructuring code without changing external behavior
Event Sourcing
Storing all state changes as immutable event sequences