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。

原文を見る