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。

查看原文