-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapis.yml
More file actions
260 lines (260 loc) · 10.2 KB
/
Copy pathapis.yml
File metadata and controls
260 lines (260 loc) · 10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
aid: apidog
url: https://raw.githubusercontent.com/api-evangelist/apidog/refs/heads/main/apis.yml
name: Apidog
description: >-
Apidog is an all-in-one API development platform that connects the entire API lifecycle: visual API design,
multi-protocol debugging (HTTP, REST, GraphQL, gRPC, WebSocket, SOAP, SSE), automated testing with a CLI, smart
mocking, and published interactive documentation - all in a single collaborative workspace. As of 2026 Apidog also
ships native MCP support: an apidog-mcp-server that feeds API specs to AI coding assistants (Cursor, VS Code + Cline)
and an MCP Client inside the desktop app that visually debugs MCP servers over STDIO and Streamable HTTP with auto
OAuth 2.0 configuration.
tags:
- AI Coding
- API Design
- API Lifecycle
- API Testing
- Collaboration
- Design-First
- Documentation
- MCP
- Mocking
- Platform
type: Index
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
access: 3rd-Party
created: '2025-01-08'
modified: '2026-05-22'
position: Consumer
specificationVersion: '0.19'
apis:
- aid: apidog:apidog
name: Apidog
description: >-
Apidog's public REST API at https://api.apidog.com lets developers programmatically import API specifications into
Apidog projects (OpenAPI 3, Swagger 2, Postman Collection v2) and export Apidog projects back out as OpenAPI 2.0,
3.0, or 3.1. The API is versioned via the X-Apidog-Api-Version header (current: 2024-03-28) and authenticated with
a personal API access token sent as a Bearer Token.
humanURL: https://apidog.com/
baseURL: https://api.apidog.com
tags:
- API Design
- API Lifecycle
- Documentation
- Import
- Export
properties:
- url: https://openapi.apidog.io/
type: Documentation
- url: https://docs.apidog.com/overview-644404m0
type: GettingStarted
- url: https://docs.apidog.com/api-access-tokens
type: Authentication
- url: openapi/apidog-apidog-openapi.yml
type: OpenAPI
- url: https://legal.apidog.com/
type: TermsOfService
- url: https://apidog.com/pricing/
type: Pricing
- url: plans/apidog-plans-pricing.yml
type: Plans
- url: rate-limits/apidog-rate-limits.yml
type: RateLimits
- url: finops/apidog-finops.yml
type: FinOps
- url: rules/apidog-rules.yml
type: SpectralRules
- url: json-schema/apidog-project-schema.json
type: JSONSchema
- url: json-schema/apidog-import-result-schema.json
type: JSONSchema
- url: json-schema/apidog-export-result-schema.json
type: JSONSchema
- url: json-schema/apidog-error-schema.json
type: JSONSchema
- url: json-ld/apidog-context.jsonld
type: JSONLD
- url: vocabulary/apidog-vocabulary.yaml
type: Vocabulary
- url: examples/apidog-import-openapi-example.json
type: Examples
- url: examples/apidog-export-openapi-example.json
type: Examples
- url: examples/apidog-import-postman-collection-example.json
type: Examples
- url: graphql/apidog-graphql.md
type: GraphQL
common:
- type: AgenticAccess
url: agentic-access/apidog-agentic-access.yml
- type: TrustCenter
url: security/apidog-trust-center.yml
- type: DomainSecurity
url: security/apidog-domain-security.yml
- type: Authentication
url: authentication/apidog-authentication.yml
- type: PostmanWorkspace
url: https://www.postman.com/kinlaneapi/apidog/overview
- type: Arazzo
url: arazzo/apidog-backup-and-restore-project-workflow.yml
name: Apidog Backup And Restore Project
- type: Arazzo
url: arazzo/apidog-consolidate-sources-into-project-workflow.yml
name: Apidog Consolidate Sources Into One Project
- type: Arazzo
url: arazzo/apidog-convert-postman-to-openapi-workflow.yml
name: Apidog Convert Postman Collection To OpenAPI
- type: Arazzo
url: arazzo/apidog-downgrade-oas-version-workflow.yml
name: Apidog Downgrade OpenAPI Version
- type: Arazzo
url: arazzo/apidog-dual-format-export-archive-workflow.yml
name: Apidog Dual-Format Export Archive
- type: Arazzo
url: arazzo/apidog-import-from-url-and-verify-workflow.yml
name: Apidog Import Spec From URL And Verify
- type: Arazzo
url: arazzo/apidog-migrate-spec-between-projects-workflow.yml
name: Apidog Migrate Spec Between Projects
- type: Arazzo
url: arazzo/apidog-promote-spec-between-branches-workflow.yml
name: Apidog Promote Spec Between Branches
- type: Arazzo
url: arazzo/apidog-sync-module-across-projects-workflow.yml
name: Apidog Sync Module Across Projects
- type: LinkedIn
url: https://www.linkedin.com/company/apidog
- url: https://apidog.com/
type: Website
- url: https://docs.apidog.com/
type: Documentation
- url: https://docs.apidog.com/overview-644404m0
type: GettingStarted
- url: https://apidog.com/pricing/
type: Pricing
- url: https://apidog.com/blog/
type: Blog
- url: https://apidog.com/blog/product-updates/
type: ReleaseNotes
- url: https://status.apidog.com/
type: StatusPage
- url: https://apidog.com/articles/
type: Articles
- url: https://legal.apidog.com/
type: TermsOfService
- url: https://trust.apidog.com/
type: Security
- url: https://docs.apidog.com/apidog-support-center-748035m0
type: Support
- url: https://github.com/Apidog
type: GitHubOrganization
- url: https://github.com/Apidog/roadmap
type: RoadMap
- url: https://docs.apidog.com/installing-and-running-apidog-cli-605135m0
type: CLI
- url: https://www.npmjs.com/package/apidog-cli
type: PackageManager
- url: https://docs.apidog.com/apidog-mcp-server
type: MCPServer
- url: https://www.npmjs.com/package/apidog-mcp-server
type: MCPServer
- url: https://docs.apidog.com/mcp-client-1930835m0
type: MCPClient
- type: SDKs
url: https://github.com/Apidog/apidog-locales
- type: Features
data:
- name: API Design
description: >-
Visual OpenAPI/Swagger editor with JSON Schema support, reusable schemas, Git integration, and sprint branches
for collaborative development.
- name: API Debugging
description: >-
Multi-protocol support for HTTP, REST, GraphQL, gRPC, SOAP, WebSocket, and SSE with auto-validation of
responses against API specs and direct database connectivity.
- name: API Testing
description: >-
Visual test scenarios with CI/CD integration via the apidog-cli npm package, data-driven testing with CSV/JSON
datasets, performance testing, and AI-generated test cases.
- name: API Mocking
description: >-
Zero-configuration smart mock generation from specs, cloud-based and local mock servers, and custom mock
rules.
- name: API Documentation
description: >-
Auto-generated interactive docs with custom domains, auto-generated SSL certificates, Markdown support, and
versioning control.
- name: Team Collaboration
description: >-
Real-time synchronization, sprint branches for parallel development, role-based access control, and SSO
support.
- name: Apidog MCP Server
description: >-
Local MCP server (npx apidog-mcp-server) that feeds Apidog projects, published docs, or local/remote OpenAPI
files to AI coding assistants like Cursor and VS Code + Cline for grounded code generation.
- name: Apidog MCP Client
description: >-
Visual MCP debugging built into the Apidog app. Supports STDIO and Streamable HTTP transports with auto OAuth
2.0 configuration and a Tools / Prompts / Resources tree.
- name: AI Test Case Generation
description: >-
AI Test Engine analyzes API specs to automatically generate positive, error-handling, boundary, and security
test cases.
- name: AI Schema Descriptions and Mock
description: AI assistance to modify field descriptions and generate mock data directly inside API schemas.
- name: Enterprise Security
description: >-
SOC 2 Type II posture with GDPR and ISO 27001 alignment, TLS 1.3+ in transit, AES-256 at rest, plus optional
on-premises deployment.
- type: UseCases
data:
- name: API Design-First Development
description: Design APIs visually before writing code, enabling frontend and backend teams to work in parallel.
- name: Automated API Testing
description: >-
Build comprehensive regression test suites with CI/CD integration (Jenkins, GitHub Actions, GitLab CI,
Bitbucket) via the Apidog CLI.
- name: API Documentation Publishing
description: >-
Automatically generate and publish interactive developer documentation from API specifications, with custom
domains and white-labeling on paid tiers.
- name: Mock Server Development
description: >-
Enable frontend development independent of backend completion using intelligent mock data generation from
specs.
- name: AI-Assisted API Coding
description: >-
Connect Apidog projects to Cursor or VS Code + Cline through the Apidog MCP Server so AI assistants generate
DTOs, controllers, and client code aligned with the real API contract.
- name: AI Agent Debugging
description: >-
Use Apidog MCP Client to visually exercise MCP servers (Tools, Prompts, Resources) over STDIO or Streamable
HTTP while building AI-agent backends.
- type: Integrations
data:
- name: OpenAPI / Swagger
description: >-
Import and export OpenAPI 2.0 / 3.0 / 3.1 specifications, with Apidog-specific x-apidog-* extensions preserved
on export.
- name: Postman
description: Postman Collection v2 import with scripting-syntax compatibility.
- name: CI/CD Platforms
description: >-
Apidog CLI integrates with Jenkins, GitLab CI, GitHub Actions, and Bitbucket Pipelines for automated test
runs.
- name: Databases
description: Connects to MySQL, PostgreSQL, Oracle, SQL Server, and ClickHouse for dynamic test data.
- name: Credential Vaults
description: HashiCorp Vault, Azure Key Vault, and AWS Secrets Manager.
- name: Enterprise SSO
description: SAML 2.0, Microsoft Active Directory, OIDC, and SCIM for enterprise identity management.
- name: IntelliJ IDEA Plugin
description: IDEA plugin for JavaDoc-driven API definition generation.
- name: Cursor And VS Code + Cline
description: >-
Through apidog-mcp-server, Apidog projects and OpenAPI files become directly accessible to MCP-compatible AI
coding assistants.
- type: LlmsText
url: https://docs.apidog.com/llms.txt
maintainers:
- FN: Kin Lane
email: info@apievangelist.com