Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch '1.1.x' into 1.2.x

Browse Source
This commit is contained in:
Andy Wilkinson
2019-03-26 11:45:06 +00:00
parent e8e813c41e d94c1c75a9
commit c2c4ed7752
39 changed files with 134 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
samples/rest-notes-spring-data-rest/src/main/asciidoc/api-guide.adoc
View File

@@ -77,10 +77,10 @@ include::{snippets}/error-example/http-response.adoc[]
== Hypermedia
RESTful Notes uses hypermedia and resources include links to other resources in their
responses. Responses are in http://stateless.co/hal_specification.html[Hypertext Application
from resource to resource.
Language (HAL)] format. Links can be found beneath the `_links` key. Users of the API should
not create URIs themselves, instead they should use the above-described links to navigate
responses. Responses are in https://github.com/mikekelly/hal_specification[Hypertext
Application Language (HAL)] format. Links can be found beneath the `_links` key. Users of
the API should not create URIs themselves, instead they should use the above-described
links to navigate from resource to resource.
[[resources]]
= Resources

5
samples/rest-notes-spring-data-rest/src/main/asciidoc/getting-started-guide.adoc
View File

@@ -20,7 +20,7 @@ to describe the relationships between resources and to allow navigation between
[getting-started-running-the-service]
== Running the service
RESTful Notes is written using http://projects.spring.io/spring-boot[Spring Boot] which
RESTful Notes is written using https://projects.spring.io/spring-boot[Spring Boot] which
makes it easy to get it up and running so that you can start exploring the REST API.
The first step is to clone the Git repository:
@@ -45,7 +45,8 @@ cURL:
include::{snippets}/index/1/curl-request.adoc[]
This request should yield the following response in the
http://stateless.co/hal_specification.html[Hypertext Application Language (HAL)] format:
https://github.com/mikekelly/hal_specification[Hypertext Application Language (HAL)]
format:
include::{snippets}/index/1/http-response.adoc[]

14
samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2016 the original author or authors.
* Copyright 2014-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -124,10 +124,10 @@ public class ApiDocumentation {
this.noteRepository.deleteAll();
createNote("REST maturity model",
"http://martinfowler.com/articles/richardsonMaturityModel.html");
"https://martinfowler.com/articles/richardsonMaturityModel.html");
createNote("Hypertext Application Language (HAL)",
"http://stateless.co/hal_specification.html");
createNote("Application-Level Profile Semantics (ALPS)", "http://alps.io/spec/");
"https://github.com/mikekelly/hal_specification");
createNote("Application-Level Profile Semantics (ALPS)", "https://github.com/alps-io/spec");
this.mockMvc.perform(get("/notes"))
.andExpect(status().isOk())
@@ -154,7 +154,7 @@ public class ApiDocumentation {
Map<String, Object> note = new HashMap<String, Object>();
note.put("title", "REST maturity model");
note.put("body", "http://martinfowler.com/articles/richardsonMaturityModel.html");
note.put("body", "https://martinfowler.com/articles/richardsonMaturityModel.html");
note.put("tags", Arrays.asList(tagLocation));
this.mockMvc.perform(
@@ -182,7 +182,7 @@ public class ApiDocumentation {
Map<String, Object> note = new HashMap<String, Object>();
note.put("title", "REST maturity model");
note.put("body", "http://martinfowler.com/articles/richardsonMaturityModel.html");
note.put("body", "https://martinfowler.com/articles/richardsonMaturityModel.html");
note.put("tags", Arrays.asList(tagLocation));
String noteLocation = this.mockMvc
@@ -248,7 +248,7 @@ public class ApiDocumentation {
public void noteUpdateExample() throws Exception {
Map<String, Object> note = new HashMap<String, Object>();
note.put("title", "REST maturity model");
note.put("body", "http://martinfowler.com/articles/richardsonMaturityModel.html");
note.put("body", "https://martinfowler.com/articles/richardsonMaturityModel.html");
String noteLocation = this.mockMvc
.perform(