Practice Test GeeksAPI - Testing Practice Test
← All API Flashcard Decks

API Documentation & Specification Flashcards

6 cards from real API practice questions. Tap to flip, then mark Knew It or Still Learning — missed cards come back until you master them.

Read the first 6 API Documentation & Specification flashcards as text

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

    Answer: Defining a standard, machine-readable description of REST APIs

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

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

    Answer: Swagger UI

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

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

    Answer: Describe the structure and data types of request and response bodies

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

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

    Answer: YAML or JSON

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

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

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

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

  6. What is 'design-first' API development?

    Answer: Defining the API specification before writing any implementation code

    Design-first API development writes the OpenAPI spec upfront, enabling parallel frontend and backend work and ensuring the contract is agreed upon before coding begins.