← All API Flashcard Decks

API Documentation and Design 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 and Design flashcards as text
  1. What is HATEOAS in REST API design?

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

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

  2. What is the purpose of an API changelog?

    Answer: Documenting version history and breaking changes for API consumers

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

  3. What is a 'deprecation notice' in API design?

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

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

  4. Which HTTP response header can indicate a deprecated API endpoint?

    Answer: Deprecation

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

  5. What is an API sandbox environment?

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

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

  6. What does 'backward compatibility' mean in API design?

    Answer: New API changes don't break existing client integrations

    Backward compatibility means new API versions continue to work correctly with clients built against older versions.