OpenAPI Specification (Swagger) in Rest API - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to specify the OpenAPI version in the specification.

Rest API

{
  "openapi": "[1]",
  "info": {
    "title": "Sample API",
    "version": "1.0.0"
  }
}

Drag options to blanks, or click blank then click option'

A1.0.0

B3.0.0

C2.0.0

D4.0.0

Attempts:

3 left

💡 Hint

Common Mistakes

Using Swagger 2.0 version number instead of OpenAPI 3.0.0

Putting the version number in the wrong field

The openapi field specifies the OpenAPI version. Version 3.0.0 is the correct format for OpenAPI 3 specifications.

2fill in blank

medium

Complete the code to define the HTTP method for the API path.

Rest API

"paths": {
  "/users": {
    "[1]": {
      "summary": "Get list of users",
      "responses": {
        "200": {
          "description": "A JSON array of user names"
        }
      }
    }
  }
}

Drag options to blanks, or click blank then click option'

Aget

Bpost

Cput

Ddelete

Attempts:

3 left

💡 Hint

Common Mistakes

Using POST instead of GET for retrieving data

Capitalizing the HTTP method (should be lowercase)

The HTTP method get is used to retrieve data, such as a list of users.

3fill in blank

hard

Fix the error in the response content type definition.

Rest API

"responses": {
  "200": {
    "description": "Successful response",
    "content": {
      "[1]": {
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

Drag options to blanks, or click blank then click option'

Aapplication/json

Bapplication/xml

Ctext/plain

Dimage/png

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'text/plain' instead of 'application/json'

Using image content types for JSON data

The content type application/json is used for JSON responses, which is standard for APIs returning arrays of strings.

4fill in blank

hard

Fill both blanks to define a parameter for a path variable named 'userId' of type string.

Rest API

"parameters": [
  {
    "name": "[1]",
    "in": "[2]",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Drag options to blanks, or click blank then click option'

AuserId

Bquery

Cpath

Did

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'query' instead of 'path' for path parameters

Using a different name than the path variable

The parameter name is userId and it is located in the path of the URL.

5fill in blank

hard

Fill all three blanks to define a schema property named 'age' of type integer with a minimum value of 0.

Rest API

"properties": {
  "[1]": {
    "type": "[2]",
    "minimum": [3]
  }
}

Drag options to blanks, or click blank then click option'

Aage

Bstring

C0

Dinteger

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'string' type for age

Not setting minimum value or setting it as a string

The property name is age, its type is integer, and the minimum allowed value is 0.