General
196 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
Microservice Architecture
Structuring apps as loosely coupled independent services
Event Sourcing
Storing all state changes as immutable event sequences
Container
Lightweight package with everything to run software
Agile
Iterative approach delivering value incrementally
Documentation as Code
Applying dev practices to documentation management
Site Reliability
Engineering approach to IT operations with software practices