Skip to content
Postman API Testing Tips

How To Use Swagger Hub With Postman

API Testing Blog

Streamlining Your API Testing with Swagger Hub and Postman

Swagger Hub and Postman are powerful tools for API development and testing, and using them together can significantly enhance your workflow. This guide will explain how to integrate Swagger Hub with Postman for efficient API testing.

Generating Postman Collections from Swagger Hub

Step 1: Exporting your Swagger Definition

  1. Navigate to your API in Swagger Hub.
  2. Click on the ‘Design’ tab.
  3. Select ‘Export’ from the dropdown menu.
  4. Choose ‘Postman Collection’ as the export format.
  5. Download the JSON file.

Step 2: Importing the Collection into Postman

  1. Open Postman.
  2. Click on ‘Collections’ in the left sidebar.
  3. Select ‘Import’ from the dropdown menu.
  4. Choose ‘File’ as the import source.
  5. Select the downloaded JSON file.
  6. Click ‘Import’.

You will now have a Postman Collection containing all the API endpoints defined in your Swagger definition.

Leveraging Swagger Hub for API Documentation

Step 1: Accessing your API documentation

  1. Navigate to your API in Swagger Hub.
  2. Click on the ‘Docs’ tab.
  3. You will find the interactive API documentation generated from your definition.

Step 2: Integrating Documentation with Postman

  1. Open the Postman collection you imported.
  2. Click on the ‘Documentation’ tab.
  3. You can now access the documentation directly from Postman, making it easily accessible for your testing efforts.

Sending API Requests with Postman

Step 1: Choosing an API Endpoint

  1. Select the desired API endpoint from the Postman Collection.

Step 2: Defining Request Parameters

  1. Set the HTTP method (GET, POST, PUT, DELETE, etc.).
  2. Enter any required URL parameters.
  3. Provide header information.
  4. Add the request body (if necessary) using different formats like JSON, XML, or Form-data.

Step 3: Sending the Request

  1. Click on the ‘Send’ button to execute the request.

Step 4: Analyzing the Response

  1. Review the HTTP status code and response body.
  2. Use the Postman interface to validate the response against your expected results.

Example: Testing a CRUD API

Assume you have a Swagger definition for a simple ‘Products’ API:

openapi: 3.0.0
info:
  title: Product API
  version: "1.0.0"
paths:
  /products:
    get:
      summary: Get all products
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product'
    post:
      summary: Create a new product
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
      responses:
        '201':
          description: Product created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
  /products/{productId}:
    get:
      summary: Get product by ID
      parameters:
        - in: path
          name: productId
          schema:
            type: integer
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
    put:
      summary: Update product by ID
      parameters:
        - in: path
          name: productId
          schema:
            type: integer
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
      responses:
        '200':
          description: Product updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
    delete:
      summary: Delete product by ID
      parameters:
        - in: path
          name: productId
          schema:
            type: integer
          required: true
      responses:
        '204':
          description: Product deleted

Export this definition to Postman and you’ll have a collection with requests for each CRUD operation.

To test the GET request for all products:

  1. Select the ‘/products’ GET request in the collection.
  2. Click ‘Send’.
  3. Check the response body, which should contain a list of products in JSON format.

To test the POST request for creating a new product:

  1. Select the ‘/products’ POST request.
  2. In the request body, add a JSON object with product data:
{
  "name": "Example Product",
  "description": "This is a test product",
  "price": 10.99
}
  1. Click ‘Send’.
  2. Verify that the response code is 201 and the response body includes the newly created product’s details.

You can follow similar steps to test the PUT and DELETE requests for updating and deleting products, respectively.

Conclusion

Combining Swagger Hub and Postman offers a comprehensive ecosystem for API development and testing. By leveraging Swagger Hub’s capabilities for documentation and definition generation and Postman’s robust testing features, you can streamline your workflow and ensure the quality and consistency of your APIs.

API Testing Blog