tvolkmann/labswp_2019_sose_geocaching
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Started Swagger Documentation

Browse Source
This commit is contained in:
Maximilian Leopold 2019-05-02 19:55:39 +02:00
parent 22e94a8c1a
commit 5c5adebbc4
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/hhn/labsw/bugageocaching/controller/Controller.java
View File

@ -8,6 +8,7 @@ import hhn.labsw.bugageocaching.repositories.*;
import hhn.labsw.bugageocaching.util.FinderUtil; import hhn.labsw.bugageocaching.util.FinderUtil;
import hhn.labsw.bugageocaching.util.VerificationUtil; import hhn.labsw.bugageocaching.util.VerificationUtil;
import io.jsonwebtoken.Claims; import io.jsonwebtoken.Claims;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@ -56,16 +57,18 @@ public class Controller {
fetchPublicKey(); fetchPublicKey();
} }
@ApiOperation(value = "Retrieves all Caches, including their Stations, from the Database")
@CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose
@RequestMapping(value = "/api/allCaches", method = RequestMethod.GET) @RequestMapping(value = "/api/allCaches", method = RequestMethod.GET, produces = "application/json")
@ResponseBody @ResponseBody
public ResponseEntity getAllCaches() { public ResponseEntity getAllCaches() {
return ResponseEntity.status(200).body(new Gson().toJson(cacheRepository.findAll())); return ResponseEntity.status(200).body(new Gson().toJson(cacheRepository.findAll()));
} }
@ApiOperation(value = "Starts the given Cache for the given User")
@CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose
@RequestMapping("/api/startCache") @RequestMapping(value = "/api/startCache", method = RequestMethod.POST, produces = "application/json")
@ResponseBody @ResponseBody
public ResponseEntity startCache(@RequestParam(value = "token", defaultValue = "-1") String token, public ResponseEntity startCache(@RequestParam(value = "token", defaultValue = "-1") String token,
@RequestParam String cacheID) { @RequestParam String cacheID) {

11
src/main/java/hhn/labsw/bugageocaching/entities/Cache.java
View File

@ -1,6 +1,9 @@
package hhn.labsw.bugageocaching.entities; package hhn.labsw.bugageocaching.entities;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModelProperty;
import javax.persistence.*; import javax.persistence.*;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@ -11,15 +14,23 @@ public class Cache {
@Id @Id
@GeneratedValue @GeneratedValue
@ApiModelProperty(notes = "The autogenerated CacheID (Primary Key)")
private int id; private int id;
@ApiModelProperty(notes = "The name of the Cache")
private String name; private String name;
@ApiModelProperty(notes = "The Description of the Cache")
private String description; private String description;
@ApiModelProperty(notes = "The number of ranking points the user gets fro completing the cache")
private int rankingPoints; private int rankingPoints;
@OneToMany @OneToMany
@ApiModelProperty(notes = "All stations included in the Cache")
private List<Station> stationen = new ArrayList<>(); private List<Station> stationen = new ArrayList<>();
@ApiModelProperty(notes = "The Reward for the Cache")
@ManyToOne (cascade = {CascadeType.ALL}) @ManyToOne (cascade = {CascadeType.ALL})
private Reward reward; private Reward reward;