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

Merge pull request #819 from izeye

Browse Source 
* gh-819:
  Use HTTPS for REST Assured links

Closes gh-819
This commit is contained in:
Andy Wilkinson
2022-07-15 10:09:04 +01:00
parent 6574583606 03732a2254
commit ce2c7b3777
3 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
config/nohttp/allowlist.lines
View File

@@ -1 +0,0 @@
^http://rest-assured.io.*

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

@@ -42,7 +42,7 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/rest-assured[REST Assured]
| Gradle
| Demonstrates the use of Spring REST Docs with http://rest-assured.io[REST Assured].
| Demonstrates the use of Spring REST Docs with https://rest-assured.io/[REST Assured].
|===
@@ -247,7 +247,7 @@ The following listings show how to do so in both Maven and Gradle:
[[getting-started-documentation-snippets]]
=== Generating Documentation Snippets
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://rest-assured.io/[REST Assured] to make requests to the service that you are documenting.
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 https://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.

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

@@ -9,7 +9,7 @@ To this end, Spring REST Docs uses https://asciidoctor.org[Asciidoctor] by defau
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://rest-assured.io[REST Assured 3].
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 https://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.