Sample Swagger Files

This directory contains real-world Swagger/OpenAPI examples that you can use to test and explore the swagger-mcp-server functionality.

Available Examples

📱 E-commerce API (ecommerce-api.json)

A comprehensive e-commerce platform API featuring:

Complexity: Medium Endpoints: 45 Schemas: 23 Use Cases: Online stores, marketplace platforms, retail systems

🏦 Banking API (banking-api.json)

A secure banking and financial services API including:

Complexity: High Endpoints: 67 Schemas: 34 Use Cases: Financial applications, fintech platforms, banking systems

🏥 Healthcare API (healthcare-api.json)

A HIPAA-compliant healthcare management API featuring:

Complexity: High Endpoints: 52 Schemas: 31 Use Cases: Hospital systems, clinic management, telemedicine

📱 Social Media API (social-api.json)

A modern social networking platform API including:

Complexity: Medium-High Endpoints: 38 Schemas: 19 Use Cases: Social platforms, community apps, content management

🏢 Enterprise CRM (enterprise-crm.json)

A comprehensive Customer Relationship Management API featuring:

Complexity: Very High Endpoints: 89 Schemas: 47 Use Cases: Enterprise software, CRM systems, business applications

🌐 IoT Platform (iot-platform.json)

An Internet of Things device management API including:

Complexity: Medium Endpoints: 31 Schemas: 16 Use Cases: IoT platforms, smart homes, industrial monitoring

Quick Start with Examples

Generate Sample Files

# Create a specific example
swagger-mcp-server examples create-sample --type ecommerce --output ./ecommerce-api.json

# List all available examples
swagger-mcp-server examples list

Convert and Test

# Convert sample to MCP server
swagger-mcp-server convert ecommerce-api.json --name ecommerce-demo

# Start the server
cd mcp-server-ecommerce-demo
swagger-mcp-server serve

# Test with sample queries
curl -X POST http://localhost:8080 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "searchEndpoints",
    "params": {"keywords": "product search"}
  }'

Example Use Cases by Industry

E-commerce & Retail

Financial Services

Healthcare

Technology & SaaS

Testing Scenarios

Basic Functionality Tests

# Test endpoint search
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":1,"method":"searchEndpoints","params":{"keywords":"user"}}'

# Test schema retrieval
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":2,"method":"getSchema","params":{"componentName":"User"}}'

# Test example generation
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":3,"method":"getExample","params":{"endpointId":"createUser","language":"curl"}}'

Advanced Search Tests

# Search by HTTP method
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":1,"method":"searchEndpoints","params":{"httpMethods":["POST","PUT"]}}'

# Search with filters
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":1,"method":"searchEndpoints","params":{"keywords":"payment","tags":["billing"],"deprecated":false}}'

# Complex search query
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":1,"method":"searchEndpoints","params":{"keywords":"user authentication","httpMethods":["POST"],"maxResults":5}}'

Performance Tests

# Concurrent requests test
for i in {1..10}; do
  curl -X POST http://localhost:8080 \
    -d '{"jsonrpc":"2.0","id":'$i',"method":"searchEndpoints","params":{"keywords":"test"}}' &
done
wait

# Large result set test
curl -X POST http://localhost:8080 \
  -d '{"jsonrpc":"2.0","id":1,"method":"searchEndpoints","params":{"keywords":"","maxResults":100}}'

API Complexity Comparison

Example Endpoints Schemas Complexity Best For
E-commerce 45 23 Medium Learning, demos
Banking 67 34 High Security testing
Healthcare 52 31 High Compliance scenarios
Social Media 38 19 Medium-High Real-time features
Enterprise CRM 89 47 Very High Scale testing
IoT Platform 31 16 Medium Device integration

Custom Example Creation

Adding Your Own Examples

  1. Create a valid OpenAPI 3.0+ JSON file
  2. Place it in this directory
  3. Update this README with description
  4. Test conversion and functionality

Example Template

{
  "openapi": "3.0.0",
  "info": {
    "title": "Your API Name",
    "version": "1.0.0",
    "description": "Description of your API"
  },
  "servers": [
    {
      "url": "https://api.example.com/v1",
      "description": "Production server"
    }
  ],
  "paths": {
    "/example": {
      "get": {
        "summary": "Example endpoint",
        "operationId": "getExample",
        "responses": {
          "200": {
            "description": "Success response"
          }
        }
      }
    }
  }
}

Validation and Quality

All example files are:

Contributing Examples

Want to contribute a new example? Please:

  1. Ensure OpenAPI 3.0+ compliance
  2. Include realistic, complete schemas
  3. Add meaningful descriptions and examples
  4. Test with swagger-mcp-server
  5. Update this README
  6. Submit a pull request

Popular requests: