restdocs

What problem does it solve?

This Skill simplifies the process of writing and maintaining API documentation for Spring Boot applications by providing standardized rules and helper utilities for Spring REST Docs.

Core Features & Use Cases

• Standardized Test Writing: Enforces consistent patterns for writing API documentation tests using RestDocsSupport.
• Field DSL: Offers an intuitive way to define request and response fields with type, description, and examples.
• Response Strategies: Provides clear methods for documenting single objects, arrays, and string responses.
• Use Case: When developing a new API endpoint, use this Skill to generate comprehensive, machine-readable documentation that can be transformed into human-readable guides.

Quick Start

Use the restdocs skill to document the 'create holiday' API endpoint.