API API Documentation and Design 2

Question 1

What is HATEOAS in REST API design?

Accepted Answer

Hypermedia as the Engine of Application State — embedding navigation links in responses

Answer

HATEOAS is a REST constraint where API responses include links to related actions, allowing clients to navigate the API dynamically.

Question 2

What is the purpose of an API changelog?

Accepted Answer

Documenting version history and breaking changes for API consumers

Answer

An API changelog documents what changed between versions, especially breaking changes, so consumers can plan upgrades.

Question 3

What is a 'deprecation notice' in API design?

Accepted Answer

An announcement that an API feature will be removed in a future version

Answer

A deprecation notice warns API consumers that a feature or endpoint will be removed, giving them time to migrate.

Question 4

Which HTTP response header can indicate a deprecated API endpoint?

Accepted Answer

Deprecation

Answer

The Deprecation header (RFC 8594) is a standard way to signal that an API endpoint is deprecated, often with a sunset date.

Question 5

What is an API sandbox environment?

Accepted Answer

A safe environment for developers to test API integrations without affecting production

Answer

An API sandbox is an isolated test environment that mimics production, allowing developers to test integrations without real data or side effects.

API - Testing Practice Test