restdocs

Write Spring REST Docs API documentation tests with standardized field DSL patterns.

Updated Jan 11, 2026
One-click install
npx skills add https://github.com/gykk16/spring-skeleton --skill restdocs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: restdocs
Source: https://github.com/gykk16/spring-skeleton/tree/main/.omc/skills/restdocs
Command: npx skills add https://github.com/gykk16/spring-skeleton --skill restdocs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about restdocs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write Spring REST Docs tests for API documentation?

Spring REST Docs tests are written by extending RestDocsSupport, mocking facades, and using Field DSL to define request and response fields with type, description, and examples for consistent API documentation.

How do I document array and pagination responses in Spring REST Docs?

Document array and pagination responses in Spring REST Docs by implementing specific response strategies provided for single objects, arrays, and string outputs within your test methods.

What is the Field DSL used for in Spring Boot API documentation?

The Field DSL in Spring Boot API documentation provides an intuitive way to define request and response fields by specifying their type, descriptions, and examples for machine-readable Spring REST Docs output.

Can I use this Spring REST Docs framework for Korean API field descriptions?

Yes, this framework includes specific guidance for implementing Korean field descriptions, alongside best practices for test method naming to ensure standardized API documentation generation.

Do I need AsciiDoc to generate API documentation with Spring REST Docs?

You need AsciiDoc to transform the machine-readable snippets generated by your Spring REST Docs tests into human-readable API guides for your Spring Boot application endpoints.