스프링 클라우드 컨트랙트 공식 레퍼런스를 한글로 번역한 문서입니다.

버전은 4.2.0 기준입니다.

---

Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant

Spring Cloud Contract는 TDD의 개념을 소프트웨어 아키텍처 수준으로 가져온다. Spring Cloud Contract를 이용하면 컨슈머 주도^{consumer-driven} 및 프로듀서 주도^{producer-driven} 명세^contract를 쉽게 테스트할 수 있다.

---

목차:

• Legal

1. Getting Started
   • 1.1. Introducing Spring Cloud Contract
     • 1.1.1.History
     • 1.1.2. Purposes
     • 1.1.3. What Is a Contract?
   • 1.2. A Three-second Tour
     • 1.2.1. On the Producer Side
     • 1.2.2. On the Consumer Side
   • 1.3. Developing Your First Spring Cloud Contract-based Application
     • 1.3.1. On the Producer Side
     • 1.3.2. On the Consumer Side
   • 1.4. Step-by-step Guide to Consumer Driven Contracts (CDC) with Contracts on the Producer Side
     • 1.4.1. Technical Note
     • 1.4.2. The Consumer Side (Loan Issuance)
     • 1.4.3. The Producer Side (Fraud Detection server)
     • 1.4.4. Consumer Side (Loan Issuance), Final Step
   • 1.5. Next Steps
2. Using Spring Cloud Contract
   • 2.1. Provider Contract Testing with Stubs in Nexus or Artifactory
   • 2.2. Provider Contract Testing with Stubs in Git
     • 2.2.1. Prerequisites
     • 2.2.2. The Flow
     • 2.2.3. Consumer setup
     • 2.2.4. Setting up the Producer
   • 2.3. Consumer Driven Contracts with Contracts on the Producer Side
   • 2.4. Consumer Driven Contracts with Contracts in an External Repository
     • 2.4.1. Prerequisites
     • 2.4.2. Consumer Flow
     • 2.4.3. Producer Flow
   • 2.5. Consumer-driven Contracts with Contracts on the Producer Side, Pushed to Git
   • 2.6. Provider Contract Testing with Stubs in Artifactory for a non-Spring Application
     • 2.6.1. The Flow
     • 2.6.2. Setting up the Consumer
     • 2.6.3. Setting up the Producer
   • 2.7. Provider Contract Testing with Stubs in Artifactory in a Non-JVM World
     • 2.7.1. Producer Flow
     • 2.7.2. Consumer Flow
   • 2.8. Provider Contract Testing with REST Docs and Stubs in Nexus or Artifactory
     • 2.8.1. Producer Flow
     • 2.8.2. Consumer Flow
3. Spring Cloud Contract Features
   • 3.1. Contract DSL
     • 3.1.1. Contract DSL in Groovy
     • 3.1.2. Contract DSL in Java
     • 3.1.3. Contract DSL in Kotlin
     • 3.1.4. Contract DSL in YAML
     • 3.1.5. Limitations
     • 3.1.6 Multiple Contracts in One File
     • 3.1.7. Stateful Contracts
     • 3.1.8. Common Top-Level Elements
   • 3.2. Contracts for HTTP
     • 3.2.1. HTTP Top-Level Elements
     • 3.2.2. HTTP Request
     • 3.2.3. HTTP Response
     • 3.2.4. XML Support for HTTP
     • 3.2.5. Asynchronous Support
   • 3.3. Dynamic properties
     • 3.3.1. Dynamic Properties inside the Body
     • 3.3.2. Regular Expressions
     • 3.2.3. Passing Optional Parameters
     • 3.3.4. Calling Custom Methods on the Server Side
     • 3.3.5. Referencing the Request from the Response
     • 3.3.6. Dynamic Properties in the Matchers Sections
   • 3.4. Spring Cloud Contract Integrations
     • 3.4.1. JAX-RS
     • 3.4.2. WebFlux with WebTestClient
     • 3.4.3. WebFlux with Explicit Mode
     • 3.4.4. Custom Mode
     • 3.4.5. Working with Context Paths
     • 3.4.6. Working with REST Docs
     • 3.4.7. GraphQL
     • 3.4.8. GRPC
   • 3.5. Messaging
     • 3.5.1. Messaging DSL Top-level Elements
     • 3.5.2. Integrations
     • 3.5.3. Producer Side Messaging Test Generation
     • 3.5.4. Consumer Stub Generation
     • 3.5.5. Consumer Side Messaging With Apache Camel
     • 3.5.6. Consumer Side Messaging with Spring Integration
     • 3.5.7. Consumer Side Messaging With Spring Cloud Stream
     • 3.5.8. Consumer Side Messaging With Spring JMS
   • 3.6. Spring Cloud Contract Stub Runner
     • 3.6.1. Snapshot Versions
     • 3.6.2. Publishing Stubs as JARs
     • 3.6.3. Stub Runner Core
     • 3.6.4. Stub Runner JUnit Rule and Stub Runner JUnit5 Extension
     • 3.6.5. Stub Runner Spring Cloud
     • 3.6.6. Using the Stub Runner Boot Application
     • 3.6.7. Consumer-Driven Contracts: Stubs Per Consumer
     • 3.6.8. Fetching Stubs or Contract Definitions From A Location
     • 3.6.9. Generating Stubs at Runtime
     • 3.6.10. Fail On No Stubs
     • 3.6.11. Common Properties
   • 3.7. Spring Cloud Contract WireMock
     • 3.7.1. Registering Stubs Automatically
     • 3.7.2. Using Files to Specify the Stub Bodies
     • 3.7.3. Alternative: Using JUnit Rules
     • 3.7.4. Relaxed SSL Validation for Rest Template
     • 3.7.5. WireMock and Spring MVC Mocks
4. Docker Project
   • 4.1. A Short Introduction to Maven, JARs, and Binary Storage
   • 4.2. Generating Tests on the Producer Side
     • 4.2.1. Environment Variables
     • 4.2.2. Customizing the gradle build
     • 4.2.3. Example of Usage via HTTP
     • 4.2.4. Example of Usage via Messaging
   • 4.3. Running Stubs on the Consumer Side
     • 4.3.1. Security
     • 4.3.2. Environment Variables
     • 4.3.3. Example of Usage
     • 4.3.4. Example of Usage with Messaging
   • 4.4. Running Contract Tests against Existing Middleware
     • 4.4.1. Spring Cloud Contract Docker and running Middleware
     • 4.4.2. Stub Runner Docker and running Middleware
5. Gradle Project
   • 5.1. Prerequisites
   • 5.2. Add Gradle Plugin with Dependencies
   • 5.3. Gradle and Rest Assured 2.0
   • 5.4. Snapshot Versions for Gradle
   • 5.5. Add stubs
   • 5.6. Running the Plugin
   • 5.7. Default Setup
   • 5.8. Configuring the Plugin
   • 5.9. Configuration Options
   • 5.10. Single Base Class for All Tests
   • 5.11. Different Base Classes for Contracts
     • 5.11.1. By Convention
     • 5.11.2. By Mapping
   • 5.12. Invoking Generated Tests
   • 5.13. Publishing Stubs to Artifact Repository
   • 5.14. Pushing Stubs to SCM
   • 5.15. Spring Cloud Contract Verifier on the Consumer Side
6. Maven Project
   • 6.1. Adding the Maven Plugin
   • 6.2. Maven and Rest Assured 2.0
   • 6.3. Using Snapshot and Milestone Versions for Maven
   • 6.4. Adding stubs
   • 6.5. Run Plugin
   • 6.6. Configure plugin
   • 6.7. Configuration Options
   • 6.8. Single Base Class for All Tests
   • 6.9. Using Different Base Classes for Contracts
     • 6.9.1. By Convention
     • 6.9.2. By Mapping
   • 6.10. Invoking Generated Tests
   • 6.11. Pushing Stubs to SCM
   • 6.12. Maven Plugin and STS
   • 6.13. Maven Plugin with Spock Tests
7. “How-to” Guides
   • 7.1. Why use Spring Cloud Contract?
   • 7.2. How Can I Write Contracts in a Language Other than Groovy?
   • 7.3. How Can I Provide Dynamic Values to a Contract?
   • 7.4. How to Do Stubs versioning?
     • 7.4.1. API Versioning
     • 7.4.2. JAR versioning
     • 7.4.3. Development or Production Stubs
   • 7.5. How Can I use a Common Repository with Contracts Instead of Storing Them with the Producer?
     • 7.5.1. Repo Structure
     • 7.5.2. Workflow
     • 7.5.3. Consumer
     • 7.5.4. Producer
     • 7.5.5. How Can I Define Messaging Contracts per Topic Rather than per Producer?
   • 7.6. How Can I Use Git as the Storage for Contracts and Stubs?
     • 7.6.1. Protocol Convention
     • 7.6.2. Producer
     • 7.6.3. Producer with Contracts Stored Locally
     • 7.6.4. Keeping Contracts with the Producer and Stubs in an External Repository
     • 7.6.5. Consumer
   • 7.7. How Can I Debug the Request/Response Being Sent by the Generated Tests Client?
   • 7.8. How Can I Debug the Mapping, Request, or Response Being Sent by WireMock?
   • 7.9. How Can I See What Got Registered in the HTTP Server Stub?
   • 7.10. How Can I Reference Text from File?
   • 7.11. How Can I Generate YAML, or X files from Spring Cloud Contract Contracts?
   • 7.12. How Can I Work with Transitive Dependencies?
     • 7.12.1. How Can I Mark All Application Dependencies as Optional?
     • 7.12.2. How can I Create a Separate artifactid for the Stubs?
     • 7.12.3. How can I Exclude Dependencies on the Consumer Side?
   • 7.13. How Can I Generate Spring REST Docs Snippets from the Contracts?
   • 7.14. How Can I Use Stubs from a Location
   • 7.15. How Can I Generate Stubs at Runtime
   • 7.16. How Can I Make The Build Pass if There Are No Contracts or Stubs
   • 7.17. How Can I Mark that a Contract Is in Progress
8. Spring Cloud Contract customization
   • 8.1. DSL Customization
     • 8.1.1. Extending the DSL
     • 8.1.2. Common JAR
     • 8.1.3. Adding a Test Dependency in the Project’s Dependencies
     • 8.1.4. Adding a Test Dependency in the Plugin’s Dependencies
     • 8.1.5. Referencing Classes in DSLs
   • 8.2. WireMock Customization
     • 8.2.1. Registering Your Own WireMock Extension
     • 8.2.2. Customization of WireMock Configuration
     • 8.2.3. Customization of WireMock via Metadata
     • 8.2.4. Customization of WireMock via Metadata and a Custom Processor
   • 8.3. Using the Pluggable Architecture
     • 8.3.1. Custom Contract Converter
     • 8.3.2. Using the Custom Test Generator
     • 8.3.3. Using the Custom Stub Generator
     • 8.3.4. Using the Custom Stub Runner
     • 8.3.5. Using the Custom Stub Downloader
     • 8.3.6. Using the SCM Stub Downloader
9. Common application properties
   • 9.1. How to Build Spring Cloud Contract
     • 9.1.1. Cloning the repository on Windows
     • 9.1.2. Project structure
     • 9.1.3. Commands
     • 9.1.4. Helpful scripts
   • 9.2. Configuration Properties
   • 9.3. YML Schema

---

Next :

Legal
스프링 클라우드 컨트랙트 문서 저작권 소개