ssouris

@WebAppConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class UserControllerDocumentation {

    @Rule
    public final RestDocumentation restDocumentation = new RestDocumentation(
            "target/generated-snippets"
    );

ssouris

<dependency>
      <groupId>org.springframework.restdocs</groupId>
      <artifactId>spring-restdocs-mockmvc</artifactId>
      <scope>test</scope>
</dependency>

ssouris

<properties>
    <snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
</properties>

ssouris

<plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-surefire-plugin</artifactId>
       <configuration>
           <includes>
               <include>**/*Documentation.java</include>
           </includes>
       </configuration>
</plugin>
<plugin>

ssouris

@Rule
public final RestDocumentation restDocumentation = new RestDocumentation(
            "target/generated-snippets"
);
 
@Autowired
private WebApplicationContext context;
 
private MockMvc mockMvc;
 

ssouris

[[resources-get-users]]
== Listing users
 
A `GET` request will list all of the users.
 
=== Response structure
 
include::{snippets}/getUsers/response-fields.adoc[]
 
=== Example request

ssouris

<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <version>2.7</version>
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>

ssouris

@WebAppConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class UserControllerDocumentation {

    // setup MockMVC, RestDocumentation etc omitted

    /**
     * All documentation production happens here.
     * 

ssouris

/**
 * Simple CRUD RESTful controller for {@linkplain  User} object
 */
@RestController
@RequestMapping("/api/v1/users")
public class UserController {
    
    private final UserDatastore userDatastore;

    @Autowired

ssouris

RestTemplate restTemplate = new RestTemplate();

ResponseEntity<String> response = restTemplate.getForEntity(baseUrl, String.class);
ResponseEntity<String> responseExchange = restTemplate.exchange(baseUrl, HttpMethod.GET, null, String.class);

URI uri = new URI(baseUrl);
ResponseEntity<String> responseURI = restTemplate.getForEntity(uri, String.class);
ResponseEntity<String> responseExchangeURI = restTemplate.exchange(uri, HttpMethod.GET, null, String.class);