diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4df5b8d4..b8dfcb90 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -42,5 +42,5 @@ with regard to the reporter of an incident. This Code of Conduct is adapted from the [Contributor Covenant][1], version 1.3.0, available at [contributor-covenant.org/version/1/3/0/][2]. -[1]: http://contributor-covenant.org -[2]: http://contributor-covenant.org/version/1/3/0/ \ No newline at end of file +[1]: https://contributor-covenant.org +[2]: https://contributor-covenant.org/version/1/3/0/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b609d53..2a8c3c7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,4 +62,4 @@ The project can then be imported into Eclipse using `File -> Import…` and then [1]: CODE_OF_CONDUCT.md [2]: https://support.springsource.com/spring_committer_signup -[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html \ No newline at end of file +[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html \ No newline at end of file diff --git a/docs/src/docs/asciidoc/contributing.adoc b/docs/src/docs/asciidoc/contributing.adoc index ce726ed6..c2c59436 100644 --- a/docs/src/docs/asciidoc/contributing.adoc +++ b/docs/src/docs/asciidoc/contributing.adoc @@ -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. diff --git a/docs/src/docs/asciidoc/documenting-your-api.adoc b/docs/src/docs/asciidoc/documenting-your-api.adoc index 25fc52b1..01928fba 100644 --- a/docs/src/docs/asciidoc/documenting-your-api.adoc +++ b/docs/src/docs/asciidoc/documenting-your-api.adoc @@ -444,7 +444,7 @@ A number of snippets are produced automatically when you document a call to |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 | `http-request.adoc` diff --git a/docs/src/docs/asciidoc/getting-started.adoc b/docs/src/docs/asciidoc/getting-started.adoc index 4a12eef4..69a07874 100644 --- a/docs/src/docs/asciidoc/getting-started.adoc +++ b/docs/src/docs/asciidoc/getting-started.adoc @@ -10,9 +10,9 @@ This section describes how to get started with Spring REST Docs. If you want to jump straight in, there are two sample applications available. {samples}/rest-notes-spring-hateoas[One sample] uses -http://projects.spring.io/spring-hateoas/[Spring HATEOAS] and +https://projects.spring.io/spring-hateoas/[Spring HATEOAS] and {samples}/rest-notes-spring-data-rest[the other] uses -http://projects.spring.io/spring-data-rest/[Spring Data REST]. Both samples use +https://projects.spring.io/spring-data-rest/[Spring Data REST]. Both samples use Spring REST Docs to produce a detailed API guide and a getting started walkthrough. Each sample contains a file named `api-guide.adoc` that produces an API guide for the @@ -295,7 +295,7 @@ that can be produced by Spring REST Docs. === Using the snippets The generated snippets can be included in your documentation 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 specified in the <> can be used to reference the snippets output directory. For example: diff --git a/docs/src/docs/asciidoc/index.adoc b/docs/src/docs/asciidoc/index.adoc index 17cde86e..96f519d7 100644 --- a/docs/src/docs/asciidoc/index.adoc +++ b/docs/src/docs/asciidoc/index.adoc @@ -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]] diff --git a/docs/src/docs/asciidoc/introduction.adoc b/docs/src/docs/asciidoc/introduction.adoc index 9590ac35..2eef3b6d 100644 --- a/docs/src/docs/asciidoc/introduction.adoc +++ b/docs/src/docs/asciidoc/introduction.adoc @@ -6,7 +6,7 @@ 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]. Asciidoctor processes plain text and produces +https://asciidoctor.org[Asciidoctor]. Asciidoctor processes plain text and produces HTML, styled and layed out to suit your needs. Spring REST Docs makes use of snippets produced by tests written with diff --git a/docs/src/docs/asciidoc/working-with-asciidoctor.adoc b/docs/src/docs/asciidoc/working-with-asciidoctor.adoc index ce166410..75a3ba7f 100644 --- a/docs/src/docs/asciidoc/working-with-asciidoctor.adoc +++ b/docs/src/docs/asciidoc/working-with-asciidoctor.adoc @@ -9,15 +9,15 @@ 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] [[working-with-asciidoctor-including-snippets]] === Including 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 generated snippets in your documentation. The `snippets` attribute specified in the <> can be used to reference the snippets output directory, for example: @@ -42,7 +42,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,adoc,indent=0] @@ -71,5 +71,5 @@ The title of a table can be specified using a line prefixed by a `.`: ==== 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. \ No newline at end of file diff --git a/samples/rest-notes-spring-data-rest/src/main/asciidoc/getting-started-guide.adoc b/samples/rest-notes-spring-data-rest/src/main/asciidoc/getting-started-guide.adoc index df16161a..0068e8fc 100644 --- a/samples/rest-notes-spring-data-rest/src/main/asciidoc/getting-started-guide.adoc +++ b/samples/rest-notes-spring-data-rest/src/main/asciidoc/getting-started-guide.adoc @@ -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: diff --git a/samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java b/samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java index 4eda380e..498eee26 100644 --- a/samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java +++ b/samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java @@ -125,7 +125,7 @@ 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/"); @@ -151,7 +151,7 @@ public class ApiDocumentation { Map note = new HashMap(); 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( @@ -179,7 +179,7 @@ public class ApiDocumentation { Map note = new HashMap(); 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 @@ -239,7 +239,7 @@ public class ApiDocumentation { public void noteUpdateExample() throws Exception { Map note = new HashMap(); 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( diff --git a/samples/rest-notes-spring-hateoas/src/docs/asciidoc/getting-started-guide.adoc b/samples/rest-notes-spring-hateoas/src/docs/asciidoc/getting-started-guide.adoc index 096e00ab..c951418c 100644 --- a/samples/rest-notes-spring-hateoas/src/docs/asciidoc/getting-started-guide.adoc +++ b/samples/rest-notes-spring-hateoas/src/docs/asciidoc/getting-started-guide.adoc @@ -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: diff --git a/samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java b/samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java index a0166eda..4c72fe81 100644 --- a/samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java +++ b/samples/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java @@ -151,7 +151,7 @@ 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/"); @@ -178,7 +178,7 @@ public class ApiDocumentation { Map note = new HashMap(); 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)); ConstrainedFields fields = new ConstrainedFields(NoteInput.class); @@ -209,7 +209,7 @@ public class ApiDocumentation { Map note = new HashMap(); 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 @@ -275,7 +275,7 @@ public class ApiDocumentation { public void noteUpdateExample() throws Exception { Map note = new HashMap(); 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( diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/hypermedia/HypermediaDocumentation.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/hypermedia/HypermediaDocumentation.java index 937dbbc8..f259d3b2 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/hypermedia/HypermediaDocumentation.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/hypermedia/HypermediaDocumentation.java @@ -146,7 +146,7 @@ public abstract class HypermediaDocumentation { * { * "_links": { * "self": { - * "href": "http://example.com/foo" + * "href": "https://example.com/foo" * } * } * } @@ -167,7 +167,7 @@ public abstract class HypermediaDocumentation { * "links": [ * { * "rel": "self", - * "href": "http://example.com/foo" + * "href": "https://example.com/foo" * } * ] * } diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/PrettyPrintingContentModifier.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/PrettyPrintingContentModifier.java index 67f0949d..8dbfaec7 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/PrettyPrintingContentModifier.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/preprocess/PrettyPrintingContentModifier.java @@ -82,7 +82,7 @@ public class PrettyPrintingContentModifier implements ContentModifier { public byte[] prettyPrint(byte[] original) throws Exception { Transformer transformer = TransformerFactory.newInstance().newTransformer(); transformer.setOutputProperty(OutputKeys.INDENT, "yes"); - transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", + transformer.setOutputProperty("{https://xml.apache.org/xslt}indent-amount", "4"); transformer.setOutputProperty(OutputKeys.DOCTYPE_PUBLIC, "yes"); ByteArrayOutputStream transformed = new ByteArrayOutputStream(); diff --git a/spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinkExtractorsPayloadTests.java b/spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinkExtractorsPayloadTests.java index b6d8f4c3..8889d365 100644 --- a/spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinkExtractorsPayloadTests.java +++ b/spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinkExtractorsPayloadTests.java @@ -68,23 +68,23 @@ public class LinkExtractorsPayloadTests { public void singleLink() throws IOException { Map> links = this.linkExtractor .extractLinks(createResponse("single-link")); - assertLinks(Arrays.asList(new Link("alpha", "http://alpha.example.com")), links); + assertLinks(Arrays.asList(new Link("alpha", "https://alpha.example.com")), links); } @Test public void multipleLinksWithDifferentRels() throws IOException { Map> links = this.linkExtractor .extractLinks(createResponse("multiple-links-different-rels")); - assertLinks(Arrays.asList(new Link("alpha", "http://alpha.example.com"), - new Link("bravo", "http://bravo.example.com")), links); + assertLinks(Arrays.asList(new Link("alpha", "https://alpha.example.com"), + new Link("bravo", "https://bravo.example.com")), links); } @Test public void multipleLinksWithSameRels() throws IOException { Map> links = this.linkExtractor .extractLinks(createResponse("multiple-links-same-rels")); - assertLinks(Arrays.asList(new Link("alpha", "http://alpha.example.com/one"), - new Link("alpha", "http://alpha.example.com/two")), links); + assertLinks(Arrays.asList(new Link("alpha", "https://alpha.example.com/one"), + new Link("alpha", "https://alpha.example.com/two")), links); } @Test diff --git a/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-embedded-and-links.json b/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-embedded-and-links.json index fdaf197d..e4ceed00 100644 --- a/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-embedded-and-links.json +++ b/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-embedded-and-links.json @@ -1,7 +1,7 @@ { "_links": { - "alpha": "http://alpha.example.com", - "bravo": "http://bravo.example.com" + "alpha": "https://alpha.example.com", + "bravo": "https://bravo.example.com" }, "_embedded": "embedded-test", "beta": "beta-value", diff --git a/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-links.json b/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-links.json index 794ece50..b4ca7edc 100644 --- a/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-links.json +++ b/spring-restdocs-core/src/test/resources/field-payloads/multiple-fields-and-links.json @@ -1,7 +1,7 @@ { "_links": { - "alpha": "http://alpha.example.com", - "bravo": "http://bravo.example.com" + "alpha": "https://alpha.example.com", + "bravo": "https://bravo.example.com" }, "beta": "beta-value", "charlie": "charlie-value" diff --git a/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-different-rels.json b/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-different-rels.json index 35e63537..f20e706c 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-different-rels.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-different-rels.json @@ -1,9 +1,9 @@ { "links": [ { "rel": "alpha", - "href": "http://alpha.example.com" + "href": "https://alpha.example.com" }, { "rel": "bravo", - "href": "http://bravo.example.com" + "href": "https://bravo.example.com" } ] } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-same-rels.json b/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-same-rels.json index ff0d3f4a..8257cb9f 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-same-rels.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/atom/multiple-links-same-rels.json @@ -1,9 +1,9 @@ { "links": [ { "rel": "alpha", - "href": "http://alpha.example.com/one" + "href": "https://alpha.example.com/one" }, { "rel": "alpha", - "href": "http://alpha.example.com/two" + "href": "https://alpha.example.com/two" } ] } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/atom/single-link.json b/spring-restdocs-core/src/test/resources/link-payloads/atom/single-link.json index 57532675..e50f46c1 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/atom/single-link.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/atom/single-link.json @@ -1,6 +1,6 @@ { "links": [ { "rel": "alpha", - "href": "http://alpha.example.com" + "href": "https://alpha.example.com" } ] } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/atom/wrong-format.json b/spring-restdocs-core/src/test/resources/link-payloads/atom/wrong-format.json index a5e2e40f..00c90d2f 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/atom/wrong-format.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/atom/wrong-format.json @@ -1,9 +1,9 @@ { "links": { "alpha": [{ - "href": "http://alpha.example.com/one" + "href": "https://alpha.example.com/one" }, { - "href": "http://alpha.example.com/two" + "href": "https://alpha.example.com/two" }] } } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-different-rels.json b/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-different-rels.json index 08d0f3ea..c329418c 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-different-rels.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-different-rels.json @@ -1,10 +1,10 @@ { "_links": { "alpha": { - "href": "http://alpha.example.com" + "href": "https://alpha.example.com" }, "bravo": { - "href": "http://bravo.example.com" + "href": "https://bravo.example.com" } } } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-same-rels.json b/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-same-rels.json index 45ebca3c..aa62edc5 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-same-rels.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/hal/multiple-links-same-rels.json @@ -1,9 +1,9 @@ { "_links": { "alpha": [{ - "href": "http://alpha.example.com/one" + "href": "https://alpha.example.com/one" }, { - "href": "http://alpha.example.com/two" + "href": "https://alpha.example.com/two" }] } } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/hal/single-link.json b/spring-restdocs-core/src/test/resources/link-payloads/hal/single-link.json index d19ca125..64ece04c 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/hal/single-link.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/hal/single-link.json @@ -1,7 +1,7 @@ { "_links": { "alpha": { - "href": "http://alpha.example.com" + "href": "https://alpha.example.com" } } } \ No newline at end of file diff --git a/spring-restdocs-core/src/test/resources/link-payloads/hal/wrong-format.json b/spring-restdocs-core/src/test/resources/link-payloads/hal/wrong-format.json index 7c99aa4e..a4d79046 100644 --- a/spring-restdocs-core/src/test/resources/link-payloads/hal/wrong-format.json +++ b/spring-restdocs-core/src/test/resources/link-payloads/hal/wrong-format.json @@ -1,9 +1,9 @@ { "_links": [ { "rel": "alpha", - "href": "http://alpha.example.com/one" + "href": "https://alpha.example.com/one" }, { "rel": "alpha", - "href": "http://alpha.example.com/two" + "href": "https://alpha.example.com/two" } ] } \ No newline at end of file