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

Merge branch '1.2.x'

Browse Source
This commit is contained in:
Andy Wilkinson
2019-03-26 12:11:10 +00:00
parent 4c172f44d3 590b024d70
commit 32c92bf885
42 changed files with 194 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/docs/asciidoc/contributing.adoc
View File

@@ -10,7 +10,7 @@ your contributions.
[[contributing-questions]]
=== Questions
You can ask questions about Spring REST Docs on http://stackoverflow.com[Stack Overflow]
You can ask questions about Spring REST Docs on https://stackoverflow.com[Stack Overflow]
by using the `spring-restdocs` tag. Similarly, we encourage you to help your fellow
Spring REST Docs users by answering questions.

4
docs/src/docs/asciidoc/documenting-your-api.adoc
View File

@@ -1287,11 +1287,11 @@ A number of snippets are produced automatically when you document a request and
|Snippet | Description
| `curl-request.adoc`
| Contains the http://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
| Contains the https://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
call that is being documented.
| `httpie-request.adoc`
| Contains the http://httpie.org[`HTTPie`] command that is equivalent to the `MockMvc`
| Contains the https://httpie.org[`HTTPie`] command that is equivalent to the `MockMvc`
call that is being documented.
| `http-request.adoc`

10
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -18,12 +18,12 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/rest-notes-spring-data-rest[Spring Data REST]
| Maven
| Demonstrates the creation of a getting started guide and an API guide for a service
implemented by using http://projects.spring.io/spring-data-rest/[Spring Data REST].
implemented by using https://projects.spring.io/spring-data-rest/[Spring Data REST].
| {samples}/rest-notes-spring-hateoas[Spring HATEOAS]
| Gradle
| Demonstrates the creation of a getting started guide and an API guide for a service
implemented by using http://projects.spring.io/spring-hateoas/[Spring HATEOAS].
implemented by using https://projects.spring.io/spring-hateoas/[Spring HATEOAS].
|===
@@ -64,7 +64,7 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/rest-notes-slate[Slate]
| Gradle
| Demonstrates the use of Spring REST Docs with Markdown and
http://github.com/tripit/slate[Slate].
https://github.com/tripit/slate[Slate].
| {samples}/testng[TestNG]
| Gradle
@@ -263,7 +263,7 @@ from where it will be included in the jar file.
Spring REST Docs uses Spring MVC's
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework],
Spring WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`], or
http://www.rest-assured.io[REST Assured] to make requests to the service that you are
http://rest-assured.io/[REST Assured] to make requests to the service that you are
documenting. It then produces documentation snippets for the request and the resulting
response.
@@ -580,7 +580,7 @@ the resulting HTML files depends on whether you use Maven or Gradle:
You can then include the generated snippets in the manually created Asciidoc file
(described earlier in this section) by using the
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
You can use the `snippets` attribute that is automatically set by
`spring-restdocs-asciidoctor` configured in the
<<getting-started-build-configuration,build configuration>> to reference the snippets

2
docs/src/docs/asciidoc/index.adoc
View File

@@ -12,7 +12,7 @@ Andy Wilkinson; Jay Bryant
:source: {github}/tree/{branch-or-tag}
:samples: {source}/samples
:templates: {source}spring-restdocs/src/main/resources/org/springframework/restdocs/templates
:spring-boot-docs: http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-framework-docs: https://docs.spring.io/spring-framework/docs/5.0.x/spring-framework-reference
:spring-framework-api: https://docs.spring.io/spring-framework/docs/5.0.x/javadoc-api

4
docs/src/docs/asciidoc/introduction.adoc
View File

@@ -6,14 +6,14 @@ your RESTful services.
Writing high-quality documentation is difficult. One way to ease that difficulty is to use
tools that are well-suited to the job. To this end, Spring REST Docs uses
http://asciidoctor.org[Asciidoctor] by default. Asciidoctor processes plain text and
https://asciidoctor.org[Asciidoctor] by default. Asciidoctor processes plain text and
produces HTML, styled and laid out to suit your needs. If you prefer, you can also
configure Spring REST Docs to use Markdown.
Spring REST Docs uses snippets produced by tests written with Spring MVC's
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework], Spring
WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`] or
http://www.rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
http://rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
the accuracy of your service's documentation. If a snippet is incorrect, the test that
produces it fails.

12
docs/src/docs/asciidoc/working-with-asciidoctor.adoc
View File

@@ -12,8 +12,8 @@ NOTE: Asciidoc is the document format. Asciidoctor is the tool that produces con
[[working-with-asciidoctor-resources]]
=== Resources
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
* http://asciidoctor.org/docs/user-manual[User manual]
* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
* https://asciidoctor.org/docs/user-manual[User manual]
@@ -139,7 +139,7 @@ the `curl-request` snippet to be "Example request", you can use the following at
[[working-with-asciidoctor-including-snippets-individual]]
==== Including Individual Snippets
The http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
The https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
macro] is used to include individual snippets in your documentation. You can use the
`snippets` attribute (which is automatically set by `spring-restdocs-asciidoctor`
configured in the <<getting-started-build-configuration, build configuration>>) to
@@ -167,8 +167,8 @@ snippet is included or by using a custom snippet template.
==== Formatting Columns
Asciidoctor has rich support for
http://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. As the
following example shows, you can specify the widths of a table's columns by using the
https://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. As
the following example shows, you can specify the widths of a table's columns by using the
`cols` attribute:
====
@@ -222,5 +222,5 @@ in a cell that contains the value of a `description` attribute:
==== Further Reading
See the http://asciidoctor.org/docs/user-manual/#tables[Tables section of the
See the https://asciidoctor.org/docs/user-manual/#tables[Tables section of the
Asciidoctor user manual] for more information about customizing tables.