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

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

@@ -9,7 +9,7 @@ for your RESTful services. However, we can't achieve that goal without your cont
[[contributing-questions]]
=== Questions
You can ask questions about Spring REST Docs on http://stackoverflow.com[StackOverflow]
You can ask questions about Spring REST Docs on https://stackoverflow.com[StackOverflow]
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

@@ -1032,11 +1032,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

@@ -19,12 +19,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 using http://projects.spring.io/spring-data-rest/[Spring Data REST].
implemented 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 using http://projects.spring.io/spring-hateoas/[Spring HATEOAS].
implemented using https://projects.spring.io/spring-hateoas/[Spring HATEOAS].
|===
@@ -54,7 +54,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
@@ -249,7 +249,7 @@ from where it will be included in the jar file.
=== Generating documentation snippets
Spring REST Docs uses
{spring-framework-docs}/#spring-mvc-test-framework[Spring's MVC Test framework] 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.
@@ -440,7 +440,7 @@ the resulting HTML files depends on whether you are using Maven or Gradle:
The generated snippets can then be included in the manually created Asciidoctor file from
above 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].
The `snippets` attribute that is automatically set by `spring-restdocs-asciidoctor`
configured in the <<getting-started-build-configuration, build
configuration>> can be used to reference the snippets output directory. For example:

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

@@ -12,8 +12,8 @@ Andy Wilkinson
: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-framework-docs: http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-framework-docs: https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle
[[abstract]]

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

@@ -6,13 +6,13 @@ services that is accurate and readable.
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 layed out to suit your needs. If you prefer, Spring REST Docs
can also be configured to use Markdown.
Spring REST Docs makes use of snippets produced by tests written with
{spring-framework-docs}/#spring-mvc-test-framework[Spring MVC Test] or
http://www.rest-assured.io[REST Assured] 2 and 3. This test-driven approach helps to
http://rest-assured.io[REST Assured] 2 and 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 will fail.

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

@@ -9,8 +9,8 @@ relevant to Spring REST Docs.
[[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]
@@ -127,7 +127,7 @@ should be `operation-{snippet}-title`. For example, to customize the title of th
[[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. The `snippets`
attribute that is automatically set by `spring-restdocs-asciidoctor` configured in the
<<getting-started-build-configuration, build configuration>> can be used to reference the
@@ -153,7 +153,7 @@ 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]. For
https://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. For
example, the widths of a table's columns can be specified using the `cols` attribute:
[source,indent=0]
@@ -200,5 +200,5 @@ in a cell that contains the value of a `description` attribute:
==== Further reading
Refer to the http://asciidoctor.org/docs/user-manual/#tables[Tables section of
Refer to the https://asciidoctor.org/docs/user-manual/#tables[Tables section of
the Asciidoctor user manual] for more information about customizing tables.