API API Documentation and Design

Question 1

What is OpenAPI Specification (OAS)?

Accepted Answer

A standard format for describing REST API structure and behavior

Answer

OpenAPI Specification is a standard, language-agnostic format for describing REST APIs, enabling automated tooling for documentation and testing.

Question 2

Which file format is most commonly used for OpenAPI 3.0 specifications?

Accepted Answer

JSON or YAML

Answer

OpenAPI 3.0 specifications are most commonly written in YAML or JSON format, with YAML preferred for human readability.

Question 3

What is Swagger UI used for?

Accepted Answer

Rendering interactive API documentation from an OpenAPI spec

Answer

Swagger UI renders an interactive web interface from an OpenAPI specification, allowing developers to explore and test APIs directly in the browser.

Question 4

What is 'API versioning' and why is it important?

Accepted Answer

Managing changes to an API without breaking existing clients

Answer

API versioning allows evolving an API with breaking changes while maintaining backward compatibility for existing clients.

Question 5

Which API versioning strategy includes the version in the URL path?

Accepted Answer

URL path versioning

Answer

URL path versioning embeds the version in the URL (e.g., /api/v1/users), making it explicit and easy to route.

API - Testing Practice Test