API API Documentation & Specification 3

Question 1

What does 'spec-based testing' mean in API quality assurance?

Accepted Answer

Generating and running tests automatically from the OpenAPI specification

Answer

Spec-based testing uses the OpenAPI specification to auto-generate test cases, validating that the implementation matches the declared contract.

Question 2

Which tool uses an OpenAPI or API Blueprint spec to run contract tests against a live API?

Accepted Answer

Dredd

Answer

Dredd is an open-source HTTP API testing framework that validates a live API against its OpenAPI or API Blueprint specification document.

Question 3

What is the purpose of the 'servers' section in an OpenAPI 3.0 specification?

Accepted Answer

Define the base URLs where the API is hosted (e.g., production, staging)

Answer

The 'servers' section declares the base URLs for different environments (production, staging, sandbox), allowing tools to direct requests appropriately.

Question 4

What does 'changelog' maintenance mean in the context of API documentation best practices?

Accepted Answer

Documenting every breaking and non-breaking change between API versions

Answer

An API changelog records what changed between versions — new endpoints, deprecated fields, breaking changes — helping consumers know what to update.

Question 5

What is the 'discriminator' keyword used for in OpenAPI polymorphism?

Accepted Answer

Indicate which sub-schema to use when a field's value determines the object type

Answer

The 'discriminator' property in OpenAPI enables polymorphism by specifying which field's value determines which schema variant (oneOf/anyOf) should be applied.

API - Testing Practice Test

API - Testing Practice Test

API API Documentation & Specification 3