openapi-spec-generation
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.
How to use
Zainstaluj umiejętność w swoim środowisku agenta, dodając repozytorium wshobson/agents do ścieżki wtyczek dokumentacji.
Przygotuj materiał źródłowy — jeśli masz istniejący kod API, zbierz definicje endpointów i schematy danych; jeśli projektujesz od zera, przygotuj koncepcję zasobów i operacji.
Wybierz podejście: design-first (napisz specyfikację przed kodem dla nowych API), code-first (wygeneruj ze starego kodu) lub hybrid (adnotuj kod i generuj specyfikację).
Użyj szablonu Complete API Specification jako punkt wyjścia — zawiera strukturę OpenAPI 3.1.0, sekcje info, servers, paths i components z przykładami autentykacji i rate limitingu.
Zdefiniuj wszystkie endpointy w sekcji paths, schematy danych w components/schemas oraz metody bezpieczeństwa w components/securitySchemes.
Waliduj gotową specyfikację — upewnij się, że każdy endpoint ma opisane parametry, request body, response codes i przykładowe odpowiedzi, a następnie użyj specyfikacji do generowania dokumentacji lub SDK klientów.