Skip to main content

User Guide

This comprehensive guide covers everything you need to know about using Dochia CLI effectively. From basic configuration to advanced reporting, these sections will help you master API testing with Dochia.

Available Sections​

CLI Reference​

Complete reference for all Dochia CLI commands, flags, and options. This section covers:

  • All available commands and their syntax
  • Command-line flags and parameters
  • Usage examples for each command
  • Exit codes and their meanings

Configuration​

Learn how to configure Dochia for your specific testing needs. This section includes:

  • Configuration file formats and locations
  • Authentication setup (API keys, tokens, etc.)
  • Proxy and network configuration
  • Rate limiting and timeout settings
  • Environment-specific configurations

OpenAPI Specifications​

Understand how Dochia works with OpenAPI specifications. This section covers:

  • Supported OpenAPI versions and features
  • Specification validation and preprocessing
  • Custom extensions and annotations
  • Troubleshooting specification issues
  • Best practices for OpenAPI design

Test Execution​

Master the art of running effective API tests with Dochia. This section includes:

  • Test execution strategies and patterns
  • Playbook selection and customization
  • Parallel execution and performance optimization
  • Error handling and retry mechanisms
  • Understanding test results and metrics

Reporting​

Learn how to generate, customize, and analyze test reports. This section covers:

  • Report formats (HTML, JSON, XML)
  • Customizing report content and appearance
  • Integrating reports with CI/CD pipelines
  • Report analysis and interpretation
  • Sharing and archiving test results

Getting Started​

If you're new to Dochia, we recommend following this learning path:

  1. CLI Reference - Familiarize yourself with available commands
  2. Configuration - Set up your testing environment
  3. OpenAPI Specifications - Prepare your API specifications
  4. Test Execution - Run your first comprehensive tests
  5. Reporting - Analyze and share your results

Quick Reference​

Essential Commands​

# Basic test execution
dochia test --contract api.yml --server https://api.example.com

# With custom configuration
dochia test --contract api.yml --server https://api.example.com --config dochia.properties

# Generate detailed reports
dochia test --contract api.yml --server https://api.example.com --output ./results

Common Configuration Options​

  • Authentication: API keys, bearer tokens, OAuth
  • Rate Limiting: Control request frequency
  • Timeouts: Configure connection and response timeouts
  • Proxy Settings: Route requests through proxies
  • Custom Headers: Add global headers to all requests

Advanced Topics​

Once you're comfortable with the basics, explore these advanced topics:

Need Help?​

If you encounter issues while using Dochia: