GraphQL Testing Guide

The Postman collection includes comprehensive GraphQL testing with 14 requests covering all available operations.

GraphQL Endpoint Overview

graph TB
    A[GraphQL Endpoint] --> B[Queries]
    A --> C[Mutations]
    A --> D[Info Endpoint]
    
    B --> E[List Products]
    B --> F[Get Product by ID]
    B --> G[List Warehouses]
    B --> H[Get Warehouse by ID]
    B --> I[Multi-Query]
    B --> J[Health Check]
    
    C --> K[Create Product]
    C --> L[Update Product]
    C --> M[Delete Product]
    C --> N[Create Warehouse]
    C --> O[Update Warehouse]
    C --> P[Delete Warehouse]
    
    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0

Available GraphQL Endpoints

Queries (Read Operations)

1. Health Check - Verify GraphQL API status
2. List products (complete fields) - Including timestamps
3. Product by ID with variables - Uses ``
4. Products (basic fields) - Only id, name, price
5. List warehouses (complete fields) - Including timestamps
6. Warehouse by ID with variables - Uses ``
7. Multi-query - Products and warehouses in single request

Mutations (Write Operations)

1. Create product - Mutation with complete input
2. Update product - Mutation with ProductoUpdateInput
3. Delete product - Mutation with ID
4. Create warehouse - Mutation with complete input
5. Update warehouse - Mutation with BodegaUpdateInput
6. Delete warehouse - Mutation with ID
7. Info endpoint - GET request for endpoint information

Collection Summary

pie title Request Distribution
    "REST Products" : 5
    "REST Warehouses" : 5
    "GraphQL Queries" : 7
    "GraphQL Mutations" : 6
    "Info Endpoints" : 1

Usage Examples

Health Check

curl -u user:myStrongPassword123 -X POST http://localhost:8080/api/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ health }","variables":{}}'

Response:

{
  "data": {
    "health": "GraphQL API funcionando correctamente"
  }
}

List Products

curl -u user:myStrongPassword123 -X POST http://localhost:8080/api/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ productos { id nombre precio cantidad } }"}'

Response:

{
  "data": {
    "productos": [
      {
        "id": "2",
        "nombre": "Frijoles",
        "precio": 30.0,
        "cantidad": 200
      }
    ]
  }
}

Multi-Query

curl -u user:myStrongPassword123 -X POST http://localhost:8080/api/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ productos { id nombre precio } bodegas { id nombre ubicacion } }"}'

Response:

{
  "data": {
    "productos": [...],
    "bodegas": [...]
  }
}

Complete GraphQL Schema

Types

type Producto {
    id: ID!
    nombre: String!
    descripcion: String
    precio: Float!
    cantidad: Int!
    fechaCreacion: DateTime
    fechaActualizacion: DateTime
}

type Bodega {
    id: ID!
    nombre: String!
    ubicacion: String!
    capacidad: Int!
    fechaCreacion: DateTime
    fechaActualizacion: DateTime
}

Available Queries

type Query {
    # Products
    productos: [Producto!]!
    producto(id: ID!): Producto
    
    # Warehouses
    bodegas: [Bodega!]!
    bodega(id: ID!): Bodega
    
    # Health check
    health: String!
}

Available Mutations

type Mutation {
    # Products
    crearProducto(input: ProductoInput!): ProductoResponse!
    actualizarProducto(input: ProductoUpdateInput!): ProductoResponse!
    eliminarProducto(id: ID!): DeleteResponse!
    
    # Warehouses
    crearBodega(input: BodegaInput!): BodegaResponse!
    actualizarBodega(input: BodegaUpdateInput!): BodegaResponse!
    eliminarBodega(id: ID!): DeleteResponse!
}

Use Cases Coverage

Read Operations (Queries)

• Get all resources
• Get resource by ID
• Specific field selection
• Multiple simultaneous queries
• API health verification

Write Operations (Mutations)

• Create resources (products and warehouses)
• Partial resource updates
• Delete resources
• Structured responses with success/error

Advanced Features

• Typed variables ($id: ID!)
• Operation names for debugging
• Complex inputs (ProductoInput, BodegaInput)
• Union-type responses (success + data + error)

Variables in Postman

GraphQL requests use Postman variables:

{
  "query": "query GetProducto($id: ID!) { 
    producto(id: $id) { 
      id nombre precio cantidad 
    } 
  }",
  "variables": {
    "id": ""
  }
}

Benefit: Change `` in environment and it updates in all requests.

Collection Structure

graph TD
    A[GraphQL 14 requests] --> B[Info Endpoint GET]
    A --> C[Health Check]
    A --> D[Queries 6 requests]
    A --> E[Mutations 6 requests]
    
    D --> F[List all products]
    D --> G[Product by ID with variables]
    D --> H[Products basic fields only]
    D --> I[List all warehouses]
    D --> J[Warehouse by ID with variables]
    D --> K[Multi-query products and warehouses]
    
    E --> L[Create product]
    E --> M[Update product]
    E --> N[Delete product]
    E --> O[Create warehouse]
    E --> P[Update warehouse]
    E --> Q[Delete warehouse]
    
    style A fill:#e1f5fe
    style D fill:#f3e5f5
    style E fill:#e8f5e8

Collection Features

Complete Coverage

• All queries from GraphQL schema
• All available mutations
• Health check included

Parameterized Variables

• Uses and from environment
• Easy ID changes without editing queries

Realistic Examples

• Complete sample data
• Descriptive names
• Inline comments where needed

Clear Organization

• Separation between Queries and Mutations
• Descriptive request names
• Logical grouping

Automated Testing

Running Complete GraphQL Folder

1. In Postman, right-click “GraphQL”
2. Select “Run folder”
3. Select all 14 requests
4. Click “Run GraphQL”

Suggested Test Scripts

Add to the “Tests” tab of each request:

// Verify successful response
pm.test("Status code is 200", () => {
    pm.response.to.have.status(200);
});

// Verify data exists
pm.test("Response has data", () => {
    const jsonData = pm.response.json();
    pm.expect(jsonData.data).to.exist;
});

// For mutations: verify success
pm.test("Mutation was successful", () => {
    const jsonData = pm.response.json();
    if (jsonData.data) {
        const mutation = Object.values(jsonData.data)[0];
        pm.expect(mutation.success).to.be.true;
    }
});

Testing Workflow

sequenceDiagram
    participant T as Tester
    participant P as Postman
    participant G as GraphQL API
    participant DB as Database
    
    T->>P: Import Collection
    T->>P: Select Environment
    T->>P: Run Health Check
    P->>G: POST /api/graphql
    G->>P: Health Response
    
    T->>P: Execute Queries
    P->>G: Query Products/Warehouses
    G->>DB: Fetch Data
    DB->>G: Return Data
    G->>P: GraphQL Response
    
    T->>P: Execute Mutations
    P->>G: Create/Update/Delete
    G->>DB: Modify Data
    DB->>G: Confirm Changes
    G->>P: Mutation Response
    
    Note over T,DB: Complete CRUD testing via GraphQL

Development Resources

GraphQL Documentation

• GraphQL Official Docs
• GraphQL Best Practices

Project Implementation

• Schema: agranelos-functions-crud-create/src/main/resources/schema.graphqls
• Implementation: agranelos-functions-crud-create/src/main/java/com/agranelos/inventario/graphql/

Next Steps

Immediate Actions

1. Import updated collection in Postman
2. Test each request for familiarity
3. Execute complete folder for regression testing
4. Add automated tests using examples above
5. Document project-specific use cases

Future Extensions

• Add GraphQL subscriptions (if implemented)
• Add fragments for reusability
• Create collections for different user roles
• Integrate with Newman for CI/CD

Troubleshooting

Common Issues

GraphQL endpoint not responding:

• Verify Azure Functions are running
• Check network connectivity
• Validate authentication credentials

Variables not working:

• Ensure environment is selected in Postman
• Verify variable names match (,)
• Check variable values are set in environment

Mutation failures:

• Validate input data format
• Check required fields in schema
• Verify database connectivity

Debugging

# Test GraphQL endpoint directly
curl -u user:password http://localhost:8080/api/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"{ health }"}'

# Check Postman variables
# In Postman: Environment quick look (eye icon)

# Validate schema
# Access GraphQL playground at /graphql endpoint

Total GraphQL Endpoints: 14 (7 queries + 6 mutations + 1 info)
Documentation Version: 2.0.0
Last Updated: October 12, 2025