Nuxt UI Pro
Sign in
Load Api

Validate Specification

Validating Your API Specification

Validating your API specification is an essential step to ensure its accuracy and compliance with standards. Vaktum provides comprehensive validation tools for both OpenAPI and gRPC definitions.

Validation Benefits

  • Detect Errors Early: Identify and fix specification issues before they impact your API consumers
  • Ensure Compliance: Verify that your API adheres to industry standards and best practices
  • Improve Quality: Enhance the overall quality and consistency of your API documentation

Validating via Vaktum CLI

The quickest way to validate your OpenAPI specification is through the Vaktum CLI:

🖥️ Shell
vaktum validate --api <Path to your OpenAPI file>

This command performs a comprehensive validation and reports any issues found in your specification.

Validating via Vaktum.com

  1. Navigate to the APIs section of Vaktum.com
  2. Select your API from the list or upload a new one
  3. Go to the "Validate" tab
  4. Review the validation results, which include:
    • Syntax errors
    • Semantic inconsistencies
    • Best practice recommendations
    • Security considerations

Validation via Vaktum API

You can programmatically validate your API specification using the Vaktum API:

🖥️ Shell
curl -X POST "https://api.vaktum.com/v1/apis/validate" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"file": "base64-encoded-api-specification"}'

What We Validate

Vaktum's validation includes checks for:

  • Syntax Validation: Ensures your specification follows the correct format and structure
  • Reference Resolution: Verifies that all references in your specification are valid and can be resolved
  • Schema Consistency: Checks that your data schemas are consistent and well-formed
  • Operation Validity: Validates that API operations are properly defined
  • Security Definitions: Ensures security schemes are correctly specified
  • Endpoint Uniqueness: Checks for duplicate endpoints or operations
  • Parameter Consistency: Verifies that parameters are consistently defined across operations

Interactive Validation Results

On Vaktum.com, validation results are presented in an interactive format that allows you to:

  1. Filter issues by severity (errors, warnings, information)
  2. Jump directly to the problematic section in your specification
  3. Get detailed explanations and recommendations for each issue
  4. Apply suggested fixes with a single click

Protocol Buffers (gRPC)

AI Test Generator