Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bernardo-mg/oauth-resource-server-example

Example OAUTH 2 resource server with Spring
https://github.com/bernardo-mg/oauth-resource-server-example

example oauth2 spring-ws

Last synced: about 2 months ago
JSON representation

Example OAUTH 2 resource server with Spring

Awesome Lists containing this project

README 

        
# OAuth 2 Resource Server Example



Example for setting up a OAuth 2 Resource Server on a web service with Spring Boot. Using Keycloak as the OAuth server.



## Usage



The project requires an authorization server. The Docker compose file will take care of this, while also running the project:



```

docker-compose -f docker/docker-compose.yml --project-name oauth2-resource-server-example up

```



Once started, the web service be available at [http://localhost:8080/](http://localhost:8080/).



## Requests with Postman



To make things easier import `src/test/resources/resource_server.postman_collection.json` into Postman. This file includes all the queries needed to test the project.



## Users



| User      | Password | Permissions |

|-----------|----------|-------------|

| test-user | 1234     | read, edit  |



Note that this web service requires secure tokens. The Postman requests includes an authenticated one, which takes care of this.



[![Release docs](https://img.shields.io/badge/docs-release-blue.svg)][site-release]

[![Development docs](https://img.shields.io/badge/docs-develop-blue.svg)][site-develop]



[![Release javadocs](https://img.shields.io/badge/javadocs-release-blue.svg)][javadoc-release]

[![Development javadocs](https://img.shields.io/badge/javadocs-develop-blue.svg)][javadoc-develop]



## Features



- [Spring MVC](https://spring.io/)

- [OAuth2](https://oauth.net/2/)

- Integrates with [Keycloak](https://www.keycloak.org/)

- Basic Spring Boot security auditing



## Documentation



Documentation is always generated for the latest release, kept in the 'master' branch:



- The [latest release documentation page][site-release].

- The [latest release Javadoc site][javadoc-release].



Documentation is also generated from the latest snapshot, taken from the 'develop' branch:



- The [the latest snapshot documentation page][site-develop].

- The [latest snapshot Javadoc site][javadoc-develop].



The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:



```

mvn verify site

```



The verify phase is required, otherwise some of the reports won't be generated.



## Collaborate



Any kind of help with the project will be well received, and there are two main ways to give such help:



- Reporting errors and asking for extensions through the issues management

- or forking the repository and extending the project



### Issues management



Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.



### Getting the code



If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.



## License



The project has been released under the [MIT License][license].



[issues]: https://github.com/bernardo-mg/oauth-resource-server-example/issues

[javadoc-develop]: https://docs.bernardomg.com/development/maven/oauth-resource-server-example/apidocs

[javadoc-release]: https://docs.bernardomg.com/maven/oauth-resource-server-example/apidocs

[license]: https://www.opensource.org/licenses/mit-license.php

[scm]: https://github.com/bernardo-mg/oauth-resource-server-example

[site-develop]: https://docs.bernardomg.com/development/maven/oauth-resource-server-example

[site-release]: https://docs.bernardomg.com/maven/oauth-resource-server-example