스프링 REST Docs 공식 레퍼런스를 한글로 번역한 문서입니다.

버전은 2.0.5.RELEASE 기준입니다.

---

스프링 Rest Docs는 손으로 작성한 문서를, 스프링 MVC 테스트가 자동 생성한 스니펫과 결합하는 방식으로 RESTful 서비스를 문서화한다.

---

목차:

1. Introduction
2. Getting started
   • 2.1. Sample Applications
   • 2.2. Requirements
   • 2.3. Build configuration
     • 2.3.1. Packaging the Documentation
   • 2.4. Generating Documentation Snippets
     • 2.4.1. Setting up Your Tests
     • 2.4.2. Invoking the RESTful Service
   • 2.5. Using the Snippets
3. Documenting your API
   • 3.1. Hypermedia
     • 3.1.1. Hypermedia Link Formats
     • 3.1.2. Ignoring Common Links
   • 3.2. Request and Response Payloads
     • 3.2.1. Request and Response Fields
     • 3.2.2. Documenting a Subsection of a Request or Response Payload
   • 3.3. Request Parameters
   • 3.4. Path Parameters
   • 3.5. Request Parts
   • 3.6. Request Part Payloads
     • 3.6.1. Documenting a Request Part’s Body
     • 3.6.2. Documenting a Request Part’s Fields
   • 3.7. HTTP Headers
   • 3.8. Reusing Snippets
   • 3.9. Documenting Constraints
     • 3.9.1. Finding Constraints
     • 3.9.2. Describing Constraints
     • 3.9.3. Using Constraint Descriptions in Generated Snippets
   • 3.10. Default Snippets
   • 3.11. Using Parameterized Output Directories
   • 3.12. Customizing the Output
     • 3.12.1. Customizing the Generated Snippets
     • 3.12.2. Including Extra Information
4. Customizing requests and responses
   • 4.1. Preprocessors
     • 4.1.1. Pretty Printing
     • 4.1.2. Masking Links
     • 4.1.3. Removing Headers
     • 4.1.4. Replacing Patterns
     • 4.1.5. Modifying Request Parameters
     • 4.1.6. Modifying URIs
     • 4.1.7. Writing Your Own Preprocessor
5. Configuration
   • 5.1. Documented URIs
     • 5.1.1. MockMvc URI Customization
     • 5.1.2. REST Assured URI Customization
     • 5.1.3. WebTestClient URI Customization
   • 5.2. Snippet Encoding
   • 5.3. Snippet Template Format
   • 5.4. Default Snippets
   • 5.5. Default Operation Preprocessors
6. Working with Asciidoctor
   • 6.1. Resources
   • 6.2. Including Snippets
     • 6.2.1. Including Multiple Snippets for an Operation
     • 6.2.2. Including Individual Snippets
   • 6.3. Customizing Tables
     • 6.3.1. Formatting Columns
     • 6.3.2. Configuring the Title
     • 6.3.3. Avoiding Table Formatting Problems
     • 6.3.4. Further Reading
7. Working with Markdown
   • 7.1. Limitations
   • 7.2. Including Snippets
8. Contributing
   • 8.1. Questions
   • 8.2. Bugs
   • 8.3. Enhancements

---

Next :

Introduction
스프링 REST Docs 소개 한글 번역