Skyramp Demo Shop

The Skyramp Demo Shop mimics a very simple e-commerce setup where users can create, update, and manage a catalog of products and handle orders. It will be used throughout the Skyramp Documentation to demonstrate Skyramp's functionality and provide a playground to test out our test generation suite.

Key Artifacts

You can explore the API at: Demo Shop API - Swagger UI

We also have a sample UI application for the Demo Shop that you can explore here.

The OpenAPI specification is available here.

Sessions and Data Persistence

In order to use Demo Shop APIs, Skyramp requires a session ID. This is to ensure you can maintain your own database state without seeing activity of other users. Once you generate a session ID, you need to use that session ID in the Authorization header of all API requests to Demo Shop as a make-shift Bearer token.

• Ex. If my session ID is peach-whiskey-asteroid, an API call to POST products should include the following header: Authorization: Bearer peach-whiskey-asteroid.

Session ID Generation

You can generate a session ID one of two ways:

• Via Demo Shop UI - when you navigate to the Demo Shop UI, we automatically create a session ID for you that persists in a cookie. This session ID will be used in the Authorization header of every single action that occurs on the UI. You can also copy the session ID in order to utilize the same database state for an API call or during trace collection.

  

• Via API call - you can generate a session ID at any time simply by calling GET https://demoshop.skyramp.dev/api/v1/generate. Once generated, you can update the session in the Demo Shop UI to match the generated session ID to get the desired database state.

Clear Database State

When you use Demo Shop for the first time, the database is seeded with a small set of products, orders, and reviews for you to utilize instantly. However, as you create/update/delete data, you may find the need to reset the state of the database.

To test against a fresh database at any point, you can clear state one of two ways:

• Via Demo Shop UI - Click the “Clear State” button. This will reset the database to the original seed state while maintaining the same session ID.

  

• Via API call - you can clear state at any time simply by calling POST https://demoshop.skyramp.dev/api/v1/reset. Be sure to include your session ID in the Authorization header if you choose this method.

To ensure a clean database on the provider-side, Skyramp also automatically clears a session’s DB state if it has been inactive for 4 hours.

Key Functionality

Here is an overview of the overall data model of the Skyramp Demo Shop:

Here are the key endpoints that the Skyramp Demo Shop provides:

Products

Skyramp Demo Shop provides endpoints for managing a catalog of products.

Data Model

• name - name of product (ex. ”Macbook Pro”)

• category - shopping category that product belongs in (ex. “Laptops")

• in_stock - whether the product is in stock (ex. true, false)

• image_url - link to an image of the product (ex. “https://image.google.com/name-of-product")

• description - a description of the product (ex. ”The next generation of laptop”)

• price - the price of the product (ex. 249.99)

Methods Supported: POST, GET (single and bulk), PUT, DELETE

Useful for testing:

• Basic test generation use cases

• Basic parameter sepcifications (form params, query params, path params, etc)

Orders

Skyramp Demo Shop also provides endpoints to create and manage orders of specific products

Data Model

• customer_email - email of the customer making the order (ex. ”sahil@skyramp.dev”)

• items - a list of product IDs included in the order packaged with unit price and quantity. NOTE: You can use the Products endpoints to fetch product details about each item. Example:

  [
    {
      "product_id": 1,
      "quantity": 2
    },
    {
      "product_id": 2,
      "quantity": 3
    }
  ]

• total_price - the total price of the order, all items combined (ex. 246.95 using above example)

• status - the status of the order’s processing. Acceptable values: ["pending","confirmed","shipped","delivered","cancelled"]

Methods Supported: POST, GET (single and bulk), DELETE

• NOTE: DELETE does not remove the order from the database, rather it updates the order status to cancelled

Useful for testing:

• Request body parameter chaining with the products endpoint

• Testing trace collection for integration/load/UI/E2E tests with the products endpoint

Reviews

Through Skyramp Demo Shop, you can also leave reviews on products. Reviews is a child endpoint of products, meaning you must use the Products endpoint to fetch an ID and use the product ID as a path parameter to create/get reviews.

Data Model

• rating - an integer rating of the product (ex. 5)

• comment - a comment about the product (ex. ”Great Product!”)

Methods Supported: POST, GET (bulk)

Useful for testing:

• Path parameter chaining with the products endpoint

• Testing trace collection for integration/load tests with the products endpoint

Related topics

Installation

Generate First Test