writing-openapi-specs

SKILL.md

Reference for OpenAPI best practices and conventions. This skill provides guidance on taste, conventions, and grey areas not covered by the OpenAPI specification itself.

Operation IDs: Use lowercase with underscores, following resourceaction pattern:

Component Names: Use PascalCase for schemas, parameters, and other reusable components:

有關 OpenAPI 規範最佳實踐、命名約定以及表達複雜 REST API 模式（如多態性、枚舉、文件上傳和服務器發送事件）的參考指南。在編寫或改進 OpenAPI 規範時使用，以確保它們遵循既定約定並生成高質量的 SDK。 來源：speakeasy-api/agent-skills。

查看原文