API-first setup pattern in Cypress - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to send a GET request to the API endpoint.

Cypress

cy.request('[1]').then((response) => {
  expect(response.status).to.eq(200)
})

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

A'/api/users'

B'GET /api/users'

C'/users/api'

D'api/users'

Attempts:

3 left

💡 Hint

Common Mistakes

Including the HTTP method in the URL string.

Omitting the leading slash in the URL path.

The cy.request command requires the URL path as a string. The correct endpoint is '/api/users'.

2fill in blank

medium

Complete the code to set up a POST request with JSON body in the API-first test.

Cypress

cy.request({
  method: 'POST',
  url: '/api/users',
  [1]: { name: 'Alice' }
}).then((response) => {
  expect(response.status).to.eq(201)
})

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

Adata

Bpayload

Cbody

Djson

Attempts:

3 left

💡 Hint

Common Mistakes

Using data or payload instead of body.

Omitting the data property entirely.

The cy.request command uses the body property to send JSON data in the request.

3fill in blank

hard

Fix the error in the assertion to check the response body contains the user name.

Cypress

cy.request('/api/users/1').then((response) => {
  expect(response.body.[1]).to.eq('Alice')
})

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

AuserName

Busername

Cuser

Dname

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect property names like username or userName.

Assuming nested objects without checking the API response.

The API response body contains the property name for the user's name, so the assertion should check response.body.name.

4fill in blank

hard

Fill both blanks to create a setup function that creates a user via API and stores the user ID.

Cypress

function setupUser() {
  return cy.request({
    method: 'POST',
    url: '/api/users',
    [1]: { name: 'Bob' }
  }).then((response) => {
    const userId = response.body.[2];
    return userId;
  });
}

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

Abody

Bid

CuserId

Dpayload

Attempts:

3 left

💡 Hint

Common Mistakes

Using payload instead of body.

Accessing a non-existent property like userId in the response.

The request data is sent in the body property, and the API returns the new user's ID in response.body.id.

5fill in blank

hard

Fill all three blanks to write a test that sets up a user, then verifies the user exists via GET request.

Cypress

it('creates and verifies a user', () => {
  setupUser().then(([1]) => {
    cy.request('/api/users/' + [2]).then((response) => {
      expect(response.body.[3]).to.eq('Bob')
    })
  })
})

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

AuserId

Cname

Did

Attempts:

3 left

💡 Hint

Common Mistakes

Using different variable names inconsistently.

Checking the wrong property in the response body.

The setupUser function returns the userId, which is used to request the user data. The response body contains the name property to verify.

Practice

1. What is the main benefit of using the API-first setup pattern in Cypress tests?

easy

A. It prepares test data quickly by calling backend APIs before UI tests run.

B. It replaces UI tests completely with API tests.

C. It slows down tests by adding extra API calls.

D. It only works for frontend UI testing without backend interaction.

Solution

1. Step 1: Understand API-first setup purpose

   API-first setup means using backend API calls to prepare data before UI tests.

2. Step 2: Identify the benefit

   This approach makes tests faster and more reliable by avoiding UI data entry steps.

3. Final Answer:

   It prepares test data quickly by calling backend APIs before UI tests run. -> Option A

4. Quick Check:

   API-first setup = faster, reliable test data setup [OK]

Hint: API-first means setup via backend calls before UI tests [OK]

Common Mistakes:

• Thinking API-first replaces UI tests
• Assuming API calls slow down tests
• Believing API-first only works on frontend

2. Which of the following is the correct way to make an API call in Cypress for setup?

easy

A. cy.fetch('POST', '/users', {name: 'John'})

B. cy.api('POST', '/users', {name: 'John'})

C. cy.call('POST', '/users', {name: 'John'})

D. cy.request('POST', '/users', {name: 'John'})

Solution

1. Step 1: Recall Cypress API call syntax

   Cypress uses cy.request() to make HTTP requests.

2. Step 2: Match correct method and parameters

   cy.request('POST', url, body) is the correct syntax.

3. Final Answer:

   cy.request('POST', '/users', {name: 'John'}) -> Option D

4. Quick Check:

   Use cy.request() for API calls in Cypress [OK]

Hint: Use cy.request() for API calls in Cypress [OK]

Common Mistakes:

• Using cy.api() which is not a Cypress command
• Using cy.call() or cy.fetch() which don't exist in Cypress
• Mixing up method names or parameters

3. Given this Cypress test snippet using API-first setup:

cy.request('POST', '/api/users', {name: 'Alice'}).then((response) => {
  expect(response.status).to.eq(201)
  cy.visit('/users/' + response.body.id)
})

What will happen if the API returns status 400 instead of 201?

medium

A. The test will continue and visit the user page anyway.

B. The test will throw a syntax error.

C. The test will fail at the assertion checking response.status.

D. The test will ignore the response and pass.

Solution

1. Step 1: Analyze the assertion on response status

   The test expects response.status to equal 201.

2. Step 2: Understand behavior if status is 400

   If status is 400, the assertion expect(response.status).to.eq(201) fails and test stops with failure.

3. Final Answer:

   The test will fail at the assertion checking response.status. -> Option C

4. Quick Check:

   Assertion fails if response.status != 201 [OK]

Hint: Assertion fails if API response status is unexpected [OK]

Common Mistakes:

• Assuming test continues after failed assertion
• Thinking Cypress throws syntax error on bad status
• Believing test ignores failed API responses

4. You wrote this API-first setup code in Cypress:

cy.request('POST', '/api/items', {name: 'Book'})
  .then((res) => {
    expect(res.status).to.eq(200)
    cy.wrap(res.body.id).as('itemId')
  })
cy.get('@itemId').then((id) => {
  cy.visit(`/items/${id}`)
})

But the test fails with "Cannot read property 'then' of undefined". What is the likely cause?

medium

A. The cy.get('@itemId') runs before the alias is set.

B. The API returned status 500 causing failure.

C. The cy.request method is misspelled.

D. The cy.wrap command cannot create aliases.

Solution

1. Step 1: Understand Cypress command chaining and timing

   Cypress commands run asynchronously and in order, but alias usage requires the alias to be set before use.

2. Step 2: Identify timing issue with alias usage

   cy.get('@itemId') is called immediately, before the alias is set inside the then callback, causing undefined error.

3. Final Answer:

   The cy.get('@itemId') runs before the alias is set. -> Option A

4. Quick Check:

   Alias must be set before cy.get() uses it [OK]

Hint: Set alias before using cy.get('@alias') to avoid timing errors [OK]

Common Mistakes:

• Assuming API error causes this specific error
• Thinking cy.request is misspelled
• Believing cy.wrap cannot create aliases

5. You want to use API-first setup to create multiple users before a UI test. Which approach correctly ensures all users are created before visiting the page?

const users = [
  {name: 'Anna'},
  {name: 'Ben'},
  {name: 'Cara'}
]

// Which code snippet is correct?

hard

A. users.forEach(user => {
cy.request('POST', '/api/users', user)
cy.visit('/users')
})

B. cy.wrap(users).each(user => {
cy.request('POST', '/api/users', user)
}).then(() => {
cy.visit('/users')
})

C. for (const user of users) {
cy.request('POST', '/api/users', user)
cy.visit('/users')
}

D. cy.wrap(users).each(user => {
cy.request('POST', '/api/users', user)
})
cy.visit('/users')

Solution

1. Step 1: Understand Cypress command queue and async behavior

   Cypress commands like cy.request are asynchronous and queued. To wait for all requests, use cy.wrap().each() with a .then() callback.

2. Step 2: Analyze each option

   The native forEach and for-of options place cy.visit() inside the loop, causing visits after each request instead of after all. The cy.wrap(users).each(...) cy.visit() executes visit before requests due to queuing. Only cy.wrap(users).each(...).then(() => cy.visit()) waits for all requests before visiting.

3. Final Answer:

   cy.wrap(users).each(user => { cy.request('POST', '/api/users', user) }).then(() => { cy.visit('/users') }) -> Option B

4. Quick Check:

   Use cy.wrap().each() with then() to wait before next step [OK]

Hint: Chain .then() after cy.wrap().each() to wait for all API calls [OK]

Common Mistakes:

• Placing cy.visit() inside the forEach or for-of loop
• Using cy.wrap().each() without .then() afterward
• Not chaining .then() to wait for all iterations