General
387 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
Semantic Versioning
Version scheme using MAJOR.MINOR.PATCH format
Scrum
Agile framework using fixed-length sprints
Microservice Architecture
Structuring apps as loosely coupled independent services
12-Factor App
Methodology for building scalable maintainable SaaS apps
Technical Writing
Creating clear documentation for technical products and APIs
Code Review
Examining code changes before merging for quality