API Documentation & Specification Flashcards
6 cards from real API practice questions. Tap to flip, then mark Knew It or Still Learning — missed cards come back until you master them.
Read the first 6 API Documentation & Specification flashcards as text
What is a 'path parameter' in an OpenAPI Specification?
Answer: A variable embedded directly in the URL path, like /users/{id}
Path parameters are variable segments in the URL path, defined with curly braces in OpenAPI (e.g., /users/{id}), used to identify specific resources.
What does the 'required' keyword in a JSON Schema or OpenAPI specification indicate?
Answer: The field must be present in the request or response payload
The 'required' array in JSON Schema/OpenAPI lists fields that must be present in the object; omitting them should result in a validation error.
Which OpenAPI component is used to define reusable request/response schemas across multiple endpoints?
Answer: components/schemas
The 'components/schemas' section defines reusable schema objects that can be referenced via $ref throughout the OpenAPI spec.
What is Redoc used for in the API documentation ecosystem?
Answer: Rendering OpenAPI specifications as clean, responsive documentation pages
Redoc is an open-source tool that renders OpenAPI 2.0/3.0 specs into polished, three-panel documentation websites.
What does 'API deprecation' mean in the context of versioning and documentation?
Answer: Marking an API endpoint as outdated and scheduled for removal, while keeping it functional
Deprecation marks an endpoint or version as obsolete, warning consumers to migrate before it is eventually removed, allowing a grace period.
What is the role of 'examples' in an OpenAPI specification?
Answer: Provide sample request and response payloads to help developers understand expected data
Examples in OpenAPI specs show concrete sample payloads for requests and responses, making documentation more useful and enabling mock server generation.