Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Get started
  • 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

Introduce Apidog

Development teams often struggle with using multiple tools like Postman and Swagger for API design, development, and testing. This fragmented approach leads to outdated API specs and chaotic collaboration.
Imagine a better way: a single, unified API platform for your entire team. With a clearly defined API specification, backend developers can seamlessly implement and test APIs, frontend developers can easily call APIs and utilize mock data, and test engineers can rapidly perform testing and generate test cases. This streamlined approach fosters collaboration and boosts productivity.
This is where Apidog comes in.
Apidog is a comprehensive, collaborative platform designed specifically for API design, development, testing, management, documentation, and mocking.

How Apidog Unifies Your Workflow#

Apidog acts as a central hub where your team can collaborate effectively. Every team member can leverage the platform to address their specific needs, all centered around the API specification.
Here's how Apidog empowers different roles:
API Designers: Visually create API specs or import existing ones, with support for branching for iterative design.
Backend Developers: Generate and send requests based on the API spec, and easily create business logic code.
Frontend Developers: Automatically generate mock data from the API spec, enabling parallel development.
QA Engineers: Generate and update requests, visually build test scenarios, and set up CI/CD pipelines.
API Maintainers: Create clear, interactive API documentation with ease.
Performance Testers: Apidog also supports robust performance testing capabilities.
Collaborate in Apidog
This integrated workflow delivers:
1.
Seamless Collaboration: Different roles collaborate efficiently, leading to continuous API improvement.
2.
Organized API Management: Replace disorganized tools with a centralized, well-structured system.
3.
Enhanced Developer Experience: Well-designed, documented APIs promote code reuse and reduce the learning curve for new developers.
Compared to tools like Postman, Apidog shines as a collaborative platform specifically tailored for API design and development teams.

Apidog: Feature-Rich and Powerful#

Apidog offers a comprehensive set of features that set it apart:
1.
Generate request params/body based on API spec
Apidog automatically generates request parameters and body content based on the API specification, saving time and reducing errors.
2.
Automated response validation
The tool automatically validates API responses against the defined specification, helping to catch discrepancies and ensure consistency.
3.
Visual assertion and variable extraction
Apidog offers a user-friendly interface for creating assertions and extracting variables from API responses, simplifying complex test case writing.
4.
Full compatibility with Postman scripts
Apidog supports full compatibility with Postman scripts, allowing teams to leverage their existing knowledge while benefiting from Apidog's additional features.
5.
Database connectivity for CRUD in API debugging
Apidog offers direct database connectivity for performing CRUD operations during API debugging, streamlining the testing process.
6.
Save requests as endpoint cases
Users can easily save API requests as endpoint cases, helping create comprehensive test suites and ensuring quick access to frequently used requests.
7.
External programming language integration
Apidog supports integration with other programming languages, allowing teams to customize their API development workflows.
8.
Perfect support for microservices architecture
The tool works well with microservices architectures, catering to the needs of distributed systems.
9.
Automatic mock data generation based on API spec
Apidog generates mock data based on the API specification, enabling frontend developers to work independently and speeding up development.
10.
Intelligent parsing of API requests into API specs
Apidog can analyze API requests and convert them into API specifications, making documentation easier.
11.
Visual orchestration of request sequences
Apidog provides a visual interface for arranging requests in sequences, making it simpler to create complex test scenarios.
12.
Self-hosted runner for test cases and mock services
Users can deploy Apidog runners on their own servers, allowing them to run test cases and create mock services in their preferred environment.
These features make Apidog a powerful and versatile tool for API development, testing, and management. By streamlining various aspects of the API lifecycle, Apidog helps teams work more effectively on their API projects.
Modified atΒ 2025-02-07 09:59:33
Previous
Apidog Learning Center
Next
Basic concepts in Apidog
Built with