Home/API/OpenAPI
API Cheat Sheet Wiki

OpenAPI cheat sheet

Machine-readable API description format for endpoints, schemas, auth, and examples.

Quick lookup

pathsCheck exact spelling, casing, and the platform documentation for this field.
componentsCheck exact spelling, casing, and the platform documentation for this field.
schemasCheck exact spelling, casing, and the platform documentation for this field.
securitySchemesCheck exact spelling, casing, and the platform documentation for this field.
operationIdCheck exact spelling, casing, and the platform documentation for this field.

Common mistakes

  • Debugging the client before checking the raw request and response
  • Ignoring headers that explain cache, auth, or rate limits
  • Treating browser CORS failures as generic API downtime
  • Logging tokens or webhook secrets while troubleshooting

Online tools