API API Documentation & Specification 2

Question 1

What is a 'path parameter' in an OpenAPI Specification?

Accepted Answer

A variable embedded directly in the URL path, like /users/{id}

Answer

Path parameters are variable segments in the URL path, defined with curly braces in OpenAPI (e.g., /users/{id}), used to identify specific resources.

Question 2

What does the 'required' keyword in a JSON Schema or OpenAPI specification indicate?

Accepted Answer

The field must be present in the request or response payload

Answer

The 'required' array in JSON Schema/OpenAPI lists fields that must be present in the object; omitting them should result in a validation error.

Question 3

Which OpenAPI component is used to define reusable request/response schemas across multiple endpoints?

Accepted Answer

components/schemas

Answer

The 'components/schemas' section defines reusable schema objects that can be referenced via $ref throughout the OpenAPI spec.

Question 4

What is Redoc used for in the API documentation ecosystem?

Accepted Answer

Rendering OpenAPI specifications as clean, responsive documentation pages

Answer

Redoc is an open-source tool that renders OpenAPI 2.0/3.0 specs into polished, three-panel documentation websites.

Question 5

What does 'API deprecation' mean in the context of versioning and documentation?

Accepted Answer

Marking an API endpoint as outdated and scheduled for removal, while keeping it functional

Answer

Deprecation marks an endpoint or version as obsolete, warning consumers to migrate before it is eventually removed, allowing a grace period.

API - Testing Practice Test