API Client

The APIClient provides a comprehensive interface for interacting with the CWE REST API. It includes built-in rate limiting, retry logic, and support for all CWE API endpoints.

APIClient

type APIClient struct {
    client  *HTTPClient // HTTP client with rate limiting
    baseURL string      // API base URL
}

The APIClient is thread-safe and can be used concurrently across multiple goroutines.

Constructors

NewAPIClient

func NewAPIClient() *APIClient

Creates a new API client with default configuration:

• Base URL: https://cwe-api.mitre.org/api/v1
• Timeout: 30 seconds
• Rate limit: 1 request per 10 seconds
• Max retries: 3
• Retry interval: 1 second

Example:

client := cwe.NewAPIClient()
// Output: Creates a new API client with default settings

NewAPIClientWithOptions

func NewAPIClientWithOptions(baseURL string, timeout time.Duration, rateLimiter ...*HTTPRateLimiter) *APIClient

Creates a new API client with custom configuration.

Parameters:

• baseURL - Custom API base URL (empty string uses default)
• timeout - HTTP request timeout (≤0 uses default 30s)
• rateLimiter - Optional custom rate limiter

Example:

// Custom configuration
limiter := cwe.NewHTTPRateLimiter(5 * time.Second)
client := cwe.NewAPIClientWithOptions(
    "https://custom-api.example.com/api/v1",
    60 * time.Second,
    limiter,
)
// Output: Creates a client with custom base URL, 60s timeout, and 5s rate limit

Version Methods

GetVersion

func (c *APIClient) GetVersion() (*VersionResponse, error)

Retrieves the current CWE version information.

Returns:

• *VersionResponse - Version information
• error - Error if request fails

Example:

version, err := client.GetVersion()
if err != nil {
    log.Fatalf("Failed to get version: %v", err)
}
fmt.Printf("CWE Version: %s, Release Date: %s\n", 
    version.Version, version.ReleaseDate)
// Output: CWE Version: 4.12, Release Date: 2023-01-15

CWE Data Methods

GetWeakness

func (c *APIClient) GetWeakness(id string) (*CWEWeakness, error)

Retrieves a specific weakness by ID.

Parameters:

• id - CWE ID (with or without "CWE-" prefix)

Returns:

• *CWEWeakness - Weakness data
• error - Error if not found or request fails

Example:

weakness, err := client.GetWeakness("79")
if err != nil {
    log.Fatalf("Failed to get weakness: %v", err)
}
fmt.Printf("CWE-79: %s\n", weakness.Name)
// Output: CWE-79: Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')

GetCategory

func (c *APIClient) GetCategory(id string) (*CWECategory, error)

Retrieves a specific category by ID.

Parameters:

• id - Category ID

Returns:

• *CWECategory - Category data
• error - Error if not found or request fails

GetView

func (c *APIClient) GetView(id string) (*CWEView, error)

Retrieves a specific view by ID.

Parameters:

• id - View ID

Returns:

• *CWEView - View data
• error - Error if not found or request fails

GetCWEs

func (c *APIClient) GetCWEs(ids []string) (map[string]*CWEWeakness, error)

Retrieves multiple CWEs in a single request.

Parameters:

• ids - Slice of CWE IDs

Returns:

• map[string]*CWEWeakness - Map of ID to weakness data
• error - Error if request fails

Example:

// Prepare a slice of CWE IDs to fetch
ids := []string{"79", "89", "287"}

// Fetch multiple CWEs in a single API call
// This is more efficient than making individual requests
cweMap, err := client.GetCWEs(ids)
if err != nil {
    log.Fatalf("Failed to get CWEs: %v", err)
}

// Iterate through the returned map and print each CWE
for id, weakness := range cweMap {
    fmt.Printf("%s: %s\n", id, weakness.Name)
}

Output:
79: Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')
89: Improper Neutralization of Special Elements used in an SQL Command ('SQL Injection')
287: Improper Authentication

Relationship Methods

GetParents

func (c *APIClient) GetParents(id string, viewID string) ([]string, error)

Retrieves parent CWE IDs for a given CWE.

Parameters:

• id - CWE ID
• viewID - Optional view ID for context

Returns:

• []string - Slice of parent CWE IDs
• error - Error if request fails

GetChildren

func (c *APIClient) GetChildren(id string, viewID string) ([]string, error)

Retrieves child CWE IDs for a given CWE.

Parameters:

• id - CWE ID
• viewID - Optional view ID for context

Returns:

• []string - Slice of child CWE IDs
• error - Error if request fails