OpenAPI Specification (Swagger) in Rest API - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ Predict Output

intermediate

What is the output of this OpenAPI snippet?

Given this OpenAPI YAML snippet describing a GET endpoint, what is the value of the summary field for the /pets path?

Rest API

paths:
  /pets:
    get:
      summary: List all pets
      responses:
        '200':
          description: A paged array of pets

A Fetch all animals

B Retrieve pets list

C List all pets

D Get pets data

💡 Hint

Look for the summary field under the get method.

The summary field directly describes the endpoint's purpose. Here, it is 'List all pets'.

🧠 Conceptual

intermediate

Which HTTP status code is used for a successful resource creation in OpenAPI?

In OpenAPI specifications, which HTTP status code should be used to indicate that a resource was successfully created?

A 201

B 200

C 204

D 400

💡 Hint

Think about the standard HTTP codes for resource creation.

HTTP status code 201 means 'Created' and is used when a new resource is successfully created.

🔧 Debug

advanced

Identify the error in this OpenAPI parameter definition

What error will this OpenAPI parameter definition cause when validating the spec?

Rest API

parameters:
  - name: userId
    in: query
    required: true
    schema:
      type: integer
      format: uuid

A Parameter 'in' must be 'path' for required parameters

B Format 'uuid' is invalid for type 'integer'

C Missing 'description' field

D Schema type must be 'string' for query parameters

💡 Hint

Check if the format matches the type.

The 'uuid' format applies only to strings, not integers. Using 'uuid' with type 'integer' is invalid.

📝 Syntax

advanced

Which option correctly defines a request body in OpenAPI 3.0?

Select the correct YAML snippet that defines a JSON request body with a required 'name' string property.

A

requestBody:
  schema:
    type: object
    properties:
      name:
        type: string
    required: [name]

B

requestBody:
  content:
    application/json:
      schema:
        properties:
          name:
            type: string
        required: name

C

requestBody:
  content:
    application/json:
      properties:
        name:
          type: string
      required: [name]

D

requestBody:
  content:
    application/json:
      schema:
        type: object
        properties:
          name:
            type: string
        required: [name]

💡 Hint

Remember the correct nesting of 'content' and 'schema' in requestBody.

Option D correctly nests 'schema' inside 'content' with proper 'required' array syntax.

🚀 Application

expert

How many endpoints are defined in this OpenAPI snippet?

Count the total number of unique HTTP methods defined under the 'paths' object.

Rest API

paths:
  /users:
    get:
      summary: Get users
    post:
      summary: Create user
  /users/{id}:
    get:
      summary: Get user by ID
    put:
      summary: Update user
    delete:
      summary: Delete user
  /status:
    get:
      summary: Get status

A 6

B 7

C 5

D 8

💡 Hint

Count each HTTP method under each path separately.

There are 2 methods under /users (get, post), 3 under /users/{id} (get, put, delete), and 1 under /status (get), totaling 6.