Apidog Docs
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
Home
Learning Center
Support Center
API References
Home
Learning Center
Support Center
API References
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
References
Copy Page
Apidog Learning Center
Get started
Introduce Apidog
Navigating Apidog
Basic concepts in 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 to Apidog
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
Overview
Create a new schema
Build a schema
Generate Schemas from JSON etc.
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 identification
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
MySQL
MongoDB
Redis
Oracle Client
Using scripts
Overview
Pre processor scripts
Post processor scripts
Public scripts
Postman scripts reference
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
Sync data from endpoints/endpoint cases
Import endpoints/endpoint cases from other projects
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 Github Actions
Integrate with Jenkins
Integrate with Gitlab
Trigger Test by Git Commit
Publish API Docs
Overview
API Technologies Supported
Quick share
View the API documentation
Markdown documentations
Publish docs sites
Custom layouts
Custom domain
SEO settings
LLM-friendly Features
Advanced Settings
Documentation Search
CORS Proxy
Integrating Google Analytics with Doc Sites
Folder tree settings
Visibility settings
Embedding values in document URLs
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
AI Features
Overview
Enable AI Features
Modify Schemas with AI
FAQs
Apidog MCP Server
Overview
Connect API Specification within Apidog Project to AI via Apidog MCP Server
Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server
Connect 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
Data & Security
Where is Apidog's data stored, and how is data security ensured?
How is user data stored? Will this data be public? Or will it be private? Will all data be stored in the cloud?
When sending requests, do they go through the Apidog server? Is data security ensured?
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
Account settings
Generate OpenAPI access token
Language settings
Hot keys
Network proxy configuration
Data backup
Updating Apidog
Deleting account
Experimental Features
References
API-Design First Approach
Apidog OpenAPI/Swagger 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
References
Copy Page
Regular Expressions
View mozilla documentation for details.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
Modified atΒ
2024-08-28 09:49:21
Previous
XPath
Next
JSON Schema