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:

Referenzhandbuch für Best Practices der OpenAPI-Spezifikation, Namenskonventionen und das Ausdrücken komplexer REST-API-Muster wie Polymorphismus, Aufzählungen, Datei-Uploads und vom Server gesendete Ereignisse. Verwenden Sie es beim Schreiben oder Verbessern von OpenAPI-Spezifikationen, um sicherzustellen, dass sie etablierten Konventionen entsprechen und hochwertige SDKs generieren. Quelle: speakeasy-api/agent-skills.

Original anzeigen