Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gateixeira/memcache
https://github.com/gateixeira/memcache
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gateixeira/memcache
- Owner: gateixeira
- License: mit
- Created: 2024-10-04T12:08:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-04T21:03:26.000Z (2 months ago)
- Last Synced: 2024-11-04T21:33:37.135Z (2 months ago)
- Language: Java
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MemcacheController Application
## Description
This Java application provides a RESTful API for interacting with a memcache service. It allows users to store, retrieve, and delete binary data associated with specific repositories and object IDs.
## Installation
1. Clone the repository:
```sh
git clone [email protected]:java-machine-testing/java-memcache.git
```
2. Navigate to the project directory:
```sh
cd java-memcache
```
3. Build the project using Maven:
```sh
mvn clean install
```
4. Run the application:
```sh
mvn spring-boot:run
```
## Usage
### Retrieve Data
- **GET** `/memcache/{repository}/{objectId}`
```sh
curl -X GET http://localhost:8080/memcache/myRepo/12345
```
### Store Data
- **POST** `/memcache/{repository}`
```sh
curl -X POST http://localhost:8080/memcache/myRepo -H "Content-Type: application/octet-stream" --data-binary @path/to/your/file
```
### Delete Data
- **DELETE** `/memcache/{repository}/{objectId}`
```sh
curl -X DELETE http://localhost:8080/memcache/myRepo/12345
```
## Endpoints
### GET `/memcache/{repository}/{objectId}`
- Retrieves the binary data associated with the given repository and object ID.
- **Response**: `200 OK` with binary data, `404 NOT FOUND` if the data does not exist.
### POST `/memcache/{repository}`
- Stores binary data in the specified repository.
- **Request Body**: Binary data.
- **Response**: `201 CREATED` with a JSON object containing the object ID.
### DELETE `/memcache/{repository}/{objectId}`
- Deletes the binary data associated with the given repository and object ID.
- **Response**: `200 OK` if the data was successfully deleted, `404 NOT FOUND` if the data does not exist.
## Dependencies
- Spring Boot
- Spring Web
## Contributing
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Create a new Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.