Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Develop and Debug APIs
  • 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 from Postman
        • 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
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Generate Schemas from JSON etc.
      • Build a schema
      • Overview
      • Create a new schema
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • 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
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • 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 API Docs
    • 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 API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog 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 Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • 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. Develop and Debug APIs

Develop and Debug APIs in Apidog

Apidog provides a full suite of features designed to make API debugging straightforward and efficient, leveraging API specifications to streamline the testing and development process. Below is an overview of the key debugging features that Apidog offers.

Automatically Generate Requests for Debugging#

Apidog automates the creation of request parameters and bodies based on your API specifications, enhancing the accuracy and efficiency of the debugging process.
Generate request params/body based on API spec: Automatically creates request parameters and bodies as defined in your API specification, ensuring precision and saving time during testing.
Generate realistic data with dynamic values: Injects realistic and dynamic values into your requests, simulating real-world scenarios and helping identify potential issues in handling data variations.
Save requests as endpoint cases: Allows you to save configurations of request parameters and bodies as endpoint cases which can be reused, making regression testing and repeated tests more efficient.

Automated Visual Testing Made Easy#

With Apidog, you can visually test your API responses without manual setup, guaranteeing that your API behaves as expected across different scenarios.
Automated response validation: Validates API responses automatically against your API specification, catching discrepancies and ensuring compliance.
Visual assertion testing: Provides a GUI for creating assertions, making it easier to define conditions your API response must meet, without writing extensive code.
Full compatibility with Postman scripts: Import your existing Postman scripts into Apidog for visual assertion creation and automated testing, preserving your existing test suites and enhancing them with Apidog’s advanced features.

Unique Capabilities That Surpass the Competition#

Apidog offers unique tools that set it apart in the market, facilitating more comprehensive API testing, particularly beneficial for complex environments.
Database connectivity for CRUD in API debugging: Directly connect to your database from Apidog to perform CRUD operations within API testing, which is essential for end-togetherness tests and more intricate API sequences.
External programming language integration: Extend Apidog’s capabilities by integrating with external programming environments, allowing for bespoke test setups and harnesses.
Perfect support for microservices architecture: Optimized to work seamlessly with microservices architectures, providing robust support and making it easier to manage and debug microservices-based applications.

Other Features#

Apidog also offers Additional tools and modes to enhance your debugging practices and API development workflow.
DESIGN/DEBUG Modes: Switch between design and debug modes to either focus on crafting your API specifications or debugging your API implementations.
Generate code: Automatically generate code snippets in various programming languages to help developers integrate with the API or reproduce issues locally.
Auto-Generate API Spec from Requests: If your API specification is outdated or missing, Apidog can reverse-engineer an API spec from the requests.
By leveraging Apidag’s comprehensive suite of debugging features, developers can significantly reduce the time and effort needed for API testing, ensuring robust, reliable, and scalable API solutions.

Best practice for different teams#

For API design-first teams#

Once the API design is complete, the backend development team can use the API Spec for developing and debugging the API. Apidog offers the following development and debugging features:

Before development#

Code generation: Apidog allows for the generation of client SDKs, server stubs, and API documentation in various programming languages based on the API specification. This automated process saves time and ensures consistency when implementing APIs.

After development#

Generating & sending API requests: Apidog allows you to generate requests based on the API specification.
Dynamic values: Dynamic values allow you to generate a new value based on a predefined rule every time you send a request. This helps streamline the debugging process and ensures that each request contains unique data.
Environments and services: Apidog supports the configuration of different environments and services, allowing developers to switch between settings for development, testing, and production environments. This feature provides flexibility in testing APIs under various conditions.
Validate responses: Developers can validate API responses against predefined schemas or criteria to ensure that the data returned by the API meets the expected format and content. This helps maintain data integrity and consistency across API responses.
Pre and post-operations: Apidog enables the definition of pre and post-processing steps that can be executed before and after API requests are sent. These operations can include data manipulation, logging, error handling, or any necessary actions to prepare for or handle the API response.
Scripting: Developers have the ability to write and execute scripts within Apidog, allowing for advanced customization and automation of tasks during API development and testing. Scripts can be used to perform complex operations, interact with external systems, or enhance the functionality of API requests and responses.
Endpoint cases: Endpoint Case in Apidog is a pre-defined test case for a specific API endpoint, which is used to streamline the process of creating, managing, and executing API tests, as well as integrating them into automated testing workflows.

For code-first teams#

If your team follows a Code-first development approach, Apidog provides a range of tools to support this workflow:
Apidog IDEA plugin: This plugin allows you to generate API specs from code, seamlessly integrating your code-first development process with API documentation creation.
Scheduled import: Apidog offers a feature to automatically synchronize from Swagger, ensuring that your API documentation stays up-to-date with changes made in your code.
DEBUG mode: With the debugging mode feature, you can make modifications to the API spec in real-time while debugging, empowering you to iterate on the API design as you develop and test your code.
Dynamic values: Dynamic values allow you to generate a new value based on a predefined rule every time you send a request. This helps streamline the debugging process and ensures that each request contains unique data.
Environments and services: Apidog supports the configuration of different environments and services, allowing developers to switch between settings for development, testing, and production environments. This feature provides flexibility in testing APIs under various conditions.
Pre and post-operations: Apidog enables the definition of pre and post-processing steps that can be executed before and after API requests are sent. These operations can include data manipulation, logging, error handling, or any necessary actions to prepare for or handle the API response.
Scripting: Developers have the ability to write and execute scripts within Apidog, allowing for advanced customization and automation of tasks during API development and testing. Scripts can be used to perform complex operations, interact with external systems, or enhance the functionality of API requests and responses.
Endpoint cases: Endpoint Case in Apidog is a pre-defined test case for a specific API endpoint, which is used to streamline the process of creating, managing, and executing API tests, as well as integrating them into automated testing workflows.
Modified at 2025-02-20 02:36:49
Previous
Endpoint unique idenfication
Next
Generate requests
Built with