https://github.com/raulrobinson/openfeign-template
API REST for OpenFeign Cloud
https://github.com/raulrobinson/openfeign-template
api-rest cloud openfeign springboot
Last synced: 2 months ago
JSON representation
API REST for OpenFeign Cloud
- Host: GitHub
- URL: https://github.com/raulrobinson/openfeign-template
- Owner: raulrobinson
- Created: 2024-12-10T16:10:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T18:35:36.000Z (over 1 year ago)
- Last Synced: 2025-01-17T05:11:57.961Z (over 1 year ago)
- Topics: api-rest, cloud, openfeign, springboot
- Language: Java
- Homepage: https://rasysbox.com
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openfeign-template
## Description
This is a template project that uses OpenFeign to make HTTP requests to a REST API. The project is written in Java and uses Spring Boot.
## Requirements
1. Java - 11.x +
2. Maven - 3.x +
3. IDE - IntelliJ IDEA or Eclipse
4. Lombok Plugin
5. Postman
6. REST API - [JSONPlaceholder](https://jsonplaceholder.typicode.com/)
7. Docker - 20.x +
## Steps to Setup
**1. Clone the application**
```bash
git clone https://github.com/raulrobinson/openfeign-template.git
```
**2. Build and run the app using maven**
```bash
mvn clean spring-boot:run
```
The app will start running at .
## Explore Rest APIs
The app defines following APIs.
```bash
curl -X 'GET' \
'http://localhost:8080/posts' \
-H 'accept: application/json'
```
```bash
curl --location 'localhost:8080/json-placeholder/get-post-by-id/15'
```
## Swagger UI
You can access the Swagger UI at .
Documentation for the REST API can be found at .
## Learn more
You can find the tutorial for this application. OpenFeign Cloud.
## License
MIT License.