API API Documentation & Specification

Question 1

What is the OpenAPI Specification (OAS) primarily used for?

Accepted Answer

Defining a standard, machine-readable description of REST APIs

Answer

OpenAPI Specification provides a standard YAML/JSON format for describing REST API endpoints, request/response schemas, and authentication methods.

Question 2

Which tool generates interactive API documentation from an OpenAPI Specification file?

Accepted Answer

Swagger UI

Answer

Swagger UI renders an OpenAPI spec as an interactive web page where developers can read documentation and send real API requests.

Question 3

What is the purpose of an API 'schema' in the context of testing?

Accepted Answer

Describe the structure and data types of request and response bodies

Answer

An API schema formally defines the expected structure, field names, data types, and required fields of request and response payloads.

Question 4

What file format is most commonly used to write OpenAPI Specification files?

Accepted Answer

YAML or JSON

Answer

OpenAPI Specification files are written in YAML (preferred for readability) or JSON, both of which are equally valid.

Question 5

What does 'API versioning' solve in API design and documentation?

Accepted Answer

Allows backward-compatible evolution of the API without breaking existing clients

Answer

API versioning (e.g., /v1/, /v2/) lets teams introduce breaking changes in new versions while keeping old clients working on previous versions.

API - Testing Practice Test