├── .gitignore ├── CONTRIBUTING.adoc ├── Jenkinsfile ├── LICENSE.txt ├── LICENSE.writing.txt ├── README.adoc ├── ci └── Dockerfile ├── complete ├── app.groovy ├── public │ ├── hello.js │ └── index.html └── run.sh ├── images └── hello.png ├── initial ├── app.groovy ├── public │ └── .gitignore └── run.sh └── test ├── expected.html └── run.sh /.gitignore: -------------------------------------------------------------------------------- 1 | *.sw? 2 | .#* 3 | *# 4 | *~ 5 | .classpath 6 | .project 7 | .settings 8 | bin 9 | build 10 | target 11 | dependency-reduced-pom.xml 12 | *.sublime-* 13 | /scratch 14 | .gradle 15 | README.html 16 | actual.html 17 | -------------------------------------------------------------------------------- /CONTRIBUTING.adoc: -------------------------------------------------------------------------------- 1 | If you have not previously done so, please fill out and 2 | submit the https://cla.pivotal.io/sign/spring[Contributor License Agreement]. -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent none 3 | 4 | triggers { 5 | pollSCM 'H/10 * * * *' 6 | } 7 | 8 | options { 9 | disableConcurrentBuilds() 10 | buildDiscarder(logRotator(numToKeepStr: '14')) 11 | } 12 | 13 | stages { 14 | stage('Publish OpenJDK 8 + Spring CLI') { 15 | when { 16 | changeset "ci/Dockerfile" 17 | } 18 | agent any 19 | 20 | steps { 21 | script { 22 | def image = docker.build("springci/gs-consuming-rest-angularjs-spring-cli", "ci/") 23 | docker.withRegistry('', 'hub.docker.com-springbuildmaster') { 24 | image.push() 25 | } 26 | } 27 | } 28 | } 29 | 30 | 31 | stage("test: baseline (jdk8)") { 32 | agent { 33 | docker { 34 | image 'springci/gs-consuming-rest-angularjs-spring-cli:latest' 35 | args '-v $HOME/.m2:/tmp/jenkins-home/.m2' 36 | } 37 | } 38 | options { timeout(time: 30, unit: 'MINUTES') } 39 | steps { 40 | sh 'test/run.sh' 41 | } 42 | } 43 | 44 | } 45 | 46 | post { 47 | changed { 48 | script { 49 | slackSend( 50 | color: (currentBuild.currentResult == 'SUCCESS') ? 'good' : 'danger', 51 | channel: '#sagan-content', 52 | message: "${currentBuild.fullDisplayName} - `${currentBuild.currentResult}`\n${env.BUILD_URL}") 53 | emailext( 54 | subject: "[${currentBuild.fullDisplayName}] ${currentBuild.currentResult}", 55 | mimeType: 'text/html', 56 | recipientProviders: [[$class: 'CulpritsRecipientProvider'], [$class: 'RequesterRecipientProvider']], 57 | body: "${currentBuild.fullDisplayName} is reported as ${currentBuild.currentResult}") 58 | } 59 | } 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | https://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "{}" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright {yyyy} {name of copyright owner} 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | https://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /LICENSE.writing.txt: -------------------------------------------------------------------------------- 1 | Except where otherwise noted, this work is licensed under https://creativecommons.org/licenses/by-nd/3.0/ 2 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :spring_boot_version: current 2 | :gs-rest-service-cors: link:/guides/gs/rest-service-cors/ 3 | :gs-spring-boot: link:/guides/gs/spring-boot/ 4 | :images: https://raw.githubusercontent.com/spring-guides/gs-consuming-rest-angularjs/main/images 5 | :toc: 6 | :icons: font 7 | :source-highlighter: prettify 8 | :project_id: gs-consuming-rest-angularjs 9 | 10 | # This repository is no longer maintained. 11 | 12 | This guide walks you through writing a simple AngularJS client that consumes a Spring MVC-based link:/understanding/REST[RESTful web service]. 13 | 14 | == What you'll build 15 | 16 | You will build an AngularJS client that consumes a Spring-based RESTful web service. 17 | Specifically, the client will consume the service created in {gs-rest-service-cors}[Building a RESTful Web Service with CORS]. 18 | 19 | The AngularJS client will be accessed by opening the `index.html` file in your browser, and will consume the service accepting requests at: 20 | 21 | http://rest-service.guides.spring.io/greeting 22 | 23 | The service will respond with a link:/understanding/JSON[JSON] representation of a greeting: 24 | 25 | [source,json] 26 | ---- 27 | {"id":1,"content":"Hello, World!"} 28 | ---- 29 | 30 | The AngularJS client will render the ID and content into the DOM. 31 | 32 | NOTE: The service at rest-service.guides.spring.io is running the code from the 33 | {gs-rest-service-cors}[CORS guide] with small modifications: 34 | there is open access to the `/greeting` endpoint because the app is using 35 | `@CrossOrigin` with no domain. 36 | 37 | == What you'll need 38 | 39 | - About 15 minutes 40 | - A favorite text editor 41 | - A modern web browser 42 | - An internet connection 43 | 44 | [[scratch]] 45 | == Create an AngularJS Controller 46 | 47 | First, you will create the AngularJS controller module that will consume the REST service: 48 | 49 | `public/hello.js` 50 | [source,js] 51 | ---- 52 | include::complete/public/hello.js[] 53 | ---- 54 | 55 | This controller module is represented as a simple JavaScript function that is given AngularJS's `$scope` and `$http` components. 56 | It uses the `$http` component to consume the REST service at "/greeting". 57 | 58 | If successful, it will assign the JSON returned back from the service to `$scope.greeting`, effectively setting a model object named "greeting". 59 | By setting that model object, AngularJS can bind it to the application page's DOM, rendering it for the user to see. 60 | 61 | == Create the Application Page 62 | 63 | Now that you have an AngularJS controller, you will create the HTML page that will load the controller into the user's web browser: 64 | 65 | `public/index.html` 66 | [source,html] 67 | ---- 68 | include::complete/public/index.html[] 69 | ---- 70 | 71 | Note the following two script tags within the `head` section. 72 | 73 | [source,html] 74 | ---- 75 | 76 | 77 | ---- 78 | 79 | The first script tag loads the minified AngularJS library (**angular.min.js**) from a content delivery network (CDN) so that you don't have to download AngularJS and place it in your project. 80 | It also loads the controller code (**hello.js**) from the application's path. 81 | 82 | The AngularJS library enables several custom attributes for use with standard HTML tags. 83 | In index.html, two such attributes are in play: 84 | 85 | * The `` tag has the `ng-app` attribute to indicate that this page is an AngularJS application. 86 | * The `
` tags which use placeholders (identified by double-curly-braces). 89 | 90 | [source,html] 91 | ---- 92 |
The ID is {{greeting.id}}
93 |The content is {{greeting.content}}
94 | ---- 95 | 96 | The placeholders reference the `id` and `content` properties of the `greeting` model object which will be set upon successfully consuming the REST service. 97 | 98 | [[run]] 99 | == Run the client 100 | 101 | To run the client, you'll need to serve it from a web server to your browser. The Spring Boot CLI (Command Line Interface) includes an embedded Tomcat server, which offers a simple approach to serving web content. See {gs-spring-boot}[Building an Application with Spring Boot] for more information about installing and using the CLI. 102 | 103 | In order to serve static content from Spring Boot's embedded Tomcat server, you'll also need to create a minimal amount of web application code so that Spring Boot knows to start Tomcat. The following `app.groovy` script is sufficient for letting Spring Boot know that you want to run Tomcat: 104 | 105 | `app.groovy` 106 | [source,groovy] 107 | ---- 108 | include::complete/app.groovy[] 109 | ---- 110 | 111 | You can now run the app using the Spring Boot CLI: 112 | 113 | ---- 114 | spring run app.groovy 115 | ---- 116 | 117 | Once the app starts, open http://localhost:8080 in your browser, where you see: 118 | 119 | image::{images}/hello.png[Model data retrieved from the REST service is rendered into the DOM.] 120 | 121 | The ID value will increment each time you refresh the page. 122 | 123 | == Summary 124 | 125 | Congratulations! You've just developed an AngularJS client that consumes a Spring-based RESTful web service. 126 | 127 | == See Also 128 | 129 | The following guides may also be helpful: 130 | 131 | * https://spring.io/guides/gs/rest-service/[Building a RESTful Web Service] 132 | * https://spring.io/guides/gs/consuming-rest/[Consuming a RESTful Web Service] 133 | * https://spring.io/guides/gs/consuming-rest-jquery/[Consuming a RESTful Web Service with jQuery] 134 | * https://spring.io/guides/gs/consuming-rest-restjs/[Consuming a RESTful Web Service with rest.js] 135 | * https://spring.io/guides/gs/accessing-gemfire-data-rest/[Accessing GemFire Data with REST] 136 | * https://spring.io/guides/gs/accessing-mongodb-data-rest/[Accessing MongoDB Data with REST] 137 | * https://spring.io/guides/gs/accessing-data-mysql/[Accessing data with MySQL] 138 | * https://spring.io/guides/gs/accessing-data-rest/[Accessing JPA Data with REST] 139 | * https://spring.io/guides/gs/accessing-neo4j-data-rest/[Accessing Neo4j Data with REST] 140 | * https://spring.io/guides/gs/securing-web/[Securing a Web Application] 141 | * https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] 142 | * https://spring.io/guides/gs/testing-restdocs/[Creating API Documentation with Restdocs] 143 | * https://spring.io/guides/gs/rest-service-cors/[Enabling Cross Origin Requests for a RESTful Web Service] 144 | * https://spring.io/guides/gs/rest-hateoas/[Building a Hypermedia-Driven RESTful Web Service] 145 | 146 | include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/footer.adoc[] 147 | -------------------------------------------------------------------------------- /ci/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM adoptopenjdk/openjdk8:latest 2 | 3 | RUN apt-get update && apt-get install -y wget 4 | 5 | RUN apt-get clean \ 6 | && rm -rf /var/lib/apt/lists/* 7 | 8 | RUN wget https://repo.spring.io/release/org/springframework/boot/spring-boot-cli/2.5.0/spring-boot-cli-2.5.0-bin.tar.gz 9 | RUN tar xvfz spring-boot-cli-2.5.0-bin.tar.gz 10 | RUN cd /usr/local/bin && ln -s /spring-2.5.0/bin/spring . 11 | -------------------------------------------------------------------------------- /complete/app.groovy: -------------------------------------------------------------------------------- 1 | @Controller class JsApp { } -------------------------------------------------------------------------------- /complete/public/hello.js: -------------------------------------------------------------------------------- 1 | angular.module('demo', []) 2 | .controller('Hello', function($scope, $http) { 3 | $http.get('http://rest-service.guides.spring.io/greeting'). 4 | then(function(response) { 5 | $scope.greeting = response.data; 6 | }); 7 | }); 8 | -------------------------------------------------------------------------------- /complete/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |The ID is {{greeting.id}}
12 |The content is {{greeting.content}}
13 |The ID is {{greeting.id}}
12 |The content is {{greeting.content}}
13 |