Apidog Docs

🇺🇸 English

🇺🇸 English
🇯🇵 日本語

Home Learning Center Support Center API References Download Changelog

🇺🇸 English

🇺🇸 English
🇯🇵 日本語

🇺🇸 English

🇺🇸 English
🇯🇵 日本語

Apidog Learning Center
Get started
- Introduction to Apidog
- Navigating Apidog
- Basic concepts in Apidog
- Quick Start
- Migration to Apidog
Design APIs
- Overview
- Create a new API project
- Endpoint basics
- APl design guidelines
- Module
- Configure multiple request body examples
- Components
- Common fields
- Global parameters
- Endpoint change history
- Comments
- Batch endpoint management
- Custom Protocol API
- Schemas
- Security schemes
- Advanced features
Develop and Debug APIs
- Overview
- Generate requests
- Send requests
- Debug cases
- Test cases
- Dynamic values
- Validate responses
- Design-first Mode & Request-first Mode
- Generate code
- Environments & variables
- Vault secrets
- Pre/Post processors
- 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)
API Testing
- Overview
- Test scenarios
- Run test scenarios
- Test reports
  - Test reports
- Test APIs
- Apidog CLI
- CI/CD
Publish API Docs
- Overview
- API Technologies Supported
- Quick share
- View the API documentation
- Markdown documentations
- Publish docs sites
- Custom layouts
- Custom CSS, JavaScript, HTML
- Custom domain
- LLM-friendly Features
- SEO settings
- Advanced Settings
- API Versions
Send requests
- Overview
- SSE debugging
- Socket.IO
- WebSocket
- Webhook
- SOAP/WebService
- GraphQL
- gRPC
- Use request proxy agents for debugging
- Create requests
- Response and cookies
- Authentication and authorization
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
- Generate Test Cases
- Modify schemas with AI
- Endpoint compliance check
- AI naming
- 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
Offline Space
- Overview
Administration
- Onboarding Checklist
  - Basic Concepts
  - Onboarding Guide
- Managing teams
- Managing Projects
- Managing Organization
Billing
- Overview
- Credits
- Unable to use credit cards?
- Managing subscriptions
- Upgrade plan
- How to move a paid team to a organization?
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
Account & preferences
- Account settings
- Generate OpenAPI access token
- Notification
- 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
Schemas
- MinifiedFestivalType
- DateType
- LocationType
- ArtistType
- FestivalType
- GetAllFestivalsResponseType
- GetFestivalByIdResponseType
- UserType
- GetUserResponseType

Home Learning Center Support Center API References Download Changelog

🇺🇸 English

🇺🇸 English
🇯🇵 日本語

🇺🇸 English

🇺🇸 English
🇯🇵 日本語

DateType

{
    "start": "string",
    "end": "string"
}

Built with