Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added video game savedata api along with readme and gitignore #241

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,62 @@ dist
.pnp.*
.vscode
.DS_Store

# For Spring boot applications Gitignore

/New_APIs/*/HELP.md
/New_APIs/*/target/
/New_APIs/*/!.mvn/wrapper/maven-wrapper.jar
/New_APIs/*/!**/src/main/**/target/
/New_APIs/*/!**/src/test/**/target/

### STS ###
/New_APIs/*/.apt_generated
/New_APIs/*/.classpath
/New_APIs/*/.factorypath
/New_APIs/*/.project
/New_APIs/*/.settings
/New_APIs/*/.springBeans
/New_APIs/*/.sts4-cache

### IntelliJ IDEA ###
/New_APIs/*/.idea
/New_APIs/*/*.iws
/New_APIs/*/*.iml
/New_APIs/*/*.ipr

### VS Code ###
/New_APIs/*/.vscode/

/New_APIs/*/.metadata
/New_APIs/*/bin/
/New_APIs/*/tmp/
/New_APIs/*/*.tmp
/New_APIs/*/*.bak
/New_APIs/*/*.swp
/New_APIs/*/*~.nib
/New_APIs/*/local.properties
/New_APIs/*/.settings/
/New_APIs/*/.loadpath
/New_APIs/*/.recommenders

/New_APIs/*/.externalToolBuilders/

# Locally stored "Eclipse launch configurations"
/New_APIs/*/*.launch

# PyDev specific (Python IDE for Eclipse)
/New_APIs/*/*.pydevproject

# CDT-specific (C/C++ Development Tooling)
/New_APIs/*/.cproject

# PDT-specific (PHP Development Tools)
/New_APIs/*/.buildpath

# sbteclipse plugin
/New_APIs/*/.target

# Tern plugin
/New_APIs/*/.tern-project

1 change: 1 addition & 0 deletions New_APIs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
|[AWS S3 Multimedia Storage Client API](./aws-client-api/)|This is a client API that facilitates interaction with an AWS S3 bucket for storing and retrieving multimedia files. By utilizing the provided functions, you can easily upload and download multimedia files to and from the S3 bucket.|
|[Music API Web Application](./music-api/)|You can access any song and listen to it. Below are some useful links and information.|
[Result-marks Data api ](./Result-marks_API/)|this is for those who want to make college management project they can simple take this api and connect to project easily|
|[Video Game Savedata API](./VideoGameSaveAPI/)|Allows for easy savedata management for implementing cloud save feature for any video game|
18 changes: 18 additions & 0 deletions New_APIs/VideoGameSaveAPI/.mvn/wrapper/maven-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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
#
# https://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.
wrapperVersion=3.3.1
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
86 changes: 86 additions & 0 deletions New_APIs/VideoGameSaveAPI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Video Game SaveData Management API

Facilitates management of video games' save data for implementation of cloud save feature for any video game. You can add new savedata, fetch all savedata fetch one save data using email of the user. For updation, deletion and retrieval of a single user the client only needs to provide the user email this is done for convinience as id of the savedata will have to be kept in a separate database otherwise.

# Base URL

http://localhost:8080/

# Endpoints


## Get All savedata

***GET /api/v1/saves***

- fetches all the savedata present in the database


## Get one savedata

***GET /api/v1/save***


- **The Email should be present in the request body like this:**

```
{
"userEmail":"[your user email]"
}
```


## Add one savedata

***Post /api/v1/save***

- **The Body of the request should contain username,email as well as savedata object**

```
{
"username":"[any user name]"
"userEmail":"[your users email]",
"savedata":"{
"property1":"value1"
"property2":"value2"
}"
}
```
- **for example:**

```
{
"username":"Stiffpixels",
"userEmail": "[email protected]",
"saveData": {
"playerName": "Stiffpixels",
"lastSaved": "04 06 2024",
"currentLevel": "Anor Londo"
}
}
```


## Update one savedata

***PUT /api/v1/save***


- **The Body should container the email along with the savedata object**

```
{
"userEmail":"[your users email]",
"savedata":"{
"property1":"value1"
"property2":"value2"
//and so on
}"
}
```

## Delete One savedata

***DELETE /api/v1/save***

- **Provide the user email like in the case of get one savedata request**
Loading
Loading