Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Get started
  2. Quick Start
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import Postman collections
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Specify an endpoint
    • Components
    • Common parameters
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Mock data automatically
    • Mock expectations
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish APIs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Overview
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Get started
  2. Quick Start

Explore more

Now that you've gotten started with Apidog, dive deeper into its robust features:

Define Your API#

Import API Specs: Apidog works with many API specification formats, making it easy to bring in existing APIs or use established standards. (Learn More)
Generate Specs from Requests: Have existing API requests? Apidog can analyze them to create API specifications, simplifying documentation. (Learn More)
Collaborate with Branches: Teams can work together on different API versions or features using branches for efficient version control. (Learn More)

Streamline API Debugging#

Effortless Request Building: Apidog automatically generates request parameters and bodies based on your API spec, reducing errors. (Learn More)
Automated Response Checks: Instantly validate API responses against your specifications, ensuring consistency. (Learn More)
Familiar Postman Support: Transition smoothly from Postman with Apidog's full support for Postman scripts. (Learn More)
Direct Database Interaction: Connect directly to your database to perform CRUD operations during debugging. (Learn More)
Extend with Programming Languages: Integrate external programming languages to customize your API development workflow. (Learn More)
Built for Microservices: Apidog seamlessly handles the complexities of microservices architectures. (Learn More)
Realistic Test Data: Generate dynamic and realistic test data for more effective API testing. (Learn More)
Code Generation: Automatically generate request code and business logic code from your API specification. (Learn More)

Sending Various Requests#

Secure Your APIs: Easily set up authentication and authorization methods for testing secure endpoints. (Learn More)
GraphQL Support: Construct and send complex GraphQL queries and mutations with ease. (Learn More)
Real-time Testing with WebSockets: Test real-time communication scenarios using WebSocket requests. (Learn More)
Legacy System Integration: Apidog supports SOAP and WebService requests for working with older systems. (Learn More)

Create Realistic Mock Data#

Automatic Mock Data: Generate realistic mock data that aligns with your API specification. (Learn More)
Use Spec Examples: Utilize pre-defined response examples from your API specification for consistent mock data. (Learn More)
Customize Responses: Define custom responses for specific mock scenarios. (Learn More)
Dynamic Mock Responses: Create mock responses that change based on input parameters. (Learn More)
Interactive Mock Scenarios: Configure mock responses to reflect input parameters for more realistic testing. (Learn More)
Cloud-Based Mocking: Set up cloud-hosted mock services for a reliable and always-available mock API environment. (Learn More)

Publish Professional API Docs#

Multiple API Versions: Manage and publish multiple versions of your API documentation for smooth transitions. (Learn More)
Custom Domain: Use your own domain for API documentation to maintain brand consistency. (Learn More)
Tailored Documentation: Customize the structure of your documentation pages to best suit your needs. (Learn More)
Modified atΒ 2025-03-14 10:12:21
Previous
Share your API documentation
Next
Send a request and save as an endpoint
Built with