โ† 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 OpenAPI Specification (OAS)?

    Answer: A standard format for describing REST API structure and behavior

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

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

    Answer: JSON or YAML

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

  3. What is Swagger UI used for?

    Answer: Rendering interactive API documentation from an OpenAPI spec

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

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

    Answer: Managing changes to an API without breaking existing clients

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

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

    Answer: URL path versioning

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

  6. What does 'API-first design' mean?

    Answer: Designing the API contract before writing implementation code

    API-first design means defining the API contract (OpenAPI spec) before writing any implementation, aligning teams and enabling parallel development.