An example of authenticating with a Spring Boot application using an API key.
If you are looking for an example using WebFlux, please check out springboot-webflux-apikey-example.
This example requires that you have a running PostgreSQL database. You can start one as a Docker container using the following commands:
$ docker pull postgres
$ docker run -p 5432:5432 postgres
Follow the steps below to run the example:
-
Ensure you have a running PostgreSQL instance at
localhost:5432. -
Run the following command to start the example application:
./gradlew bootRun -
Run the following command to send a request to the non-secure endpoint:
curl -v http://localhost:8080/api/v1/nonsecureIf successful, you will receive an
HTTP 200 OKresponse. -
Run the following command to send a request to the secure endpoint:
curl -v http://localhost:8080/api/v1/secureYou will receive an
HTTP 403 Forbiddenresponse because you have not supplied a valid API key. -
Run the following command to send a request to the secure endpoint with an API key:
curl -v --header "API_KEY: aec093c2c98144f99a4a365ad1d2f05e" http://localhost:8080/api/v1/secureIf successful, you will now receive an
HTTP 200 OKresponse because you have supplied a valid API key.
For bugs, questions, and discussions please use the Github Issues.
Copyright 2019 Greg Whitaker
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.