Skip to content

Api Endpoint updates and Prevent SQL inject attacks #57

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Api Endpoint updates and Prevent SQL inject attacks #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ We will walk through the different steps required to get the application running
git clone https://github.com/couchbase-examples/java-springboot-quickstart.git
```

### Navigate to the Project Directory

```shell
cd java-springboot-quickstart
```

### Install Dependencies

The dependencies for the application are specified in the `pom.xml` file in the root folder. Dependencies can be installed through `mvn` the default package manager for Java.
Expand Down
95 changes: 60 additions & 35 deletions src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@

import java.util.List;

import jakarta.validation.Valid;

import org.couchbase.quickstart.springboot.models.Airline;
import org.couchbase.quickstart.springboot.services.AirlineService;
import org.springframework.context.annotation.Description;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
Expand All @@ -23,6 +20,10 @@
import com.couchbase.client.core.error.DocumentNotFoundException;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import jakarta.validation.Valid;
import lombok.extern.slf4j.Slf4j;

@RestController
Expand All @@ -41,9 +42,15 @@ public AirlineController(AirlineService airlineService) {
private static final String DOCUMENT_NOT_FOUND = "Document Not Found";

@GetMapping("/{id}")
@Operation(summary = "Get an airline by ID")
@Description(value = "Get Airline by specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to retrieve a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `getAirline`")
public ResponseEntity<Airline> getAirline(@PathVariable String id) {
@Operation(summary = "Get an airline by ID", description = "Get Airline by specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to retrieve a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/main/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `getAirline`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Airline found"),
@ApiResponse(responseCode = "404", description = "Airline not found"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "id", description = "Airline ID", required = true, example = "airline_10")
public ResponseEntity<Airline> getAirline(@PathVariable(required = true) String id) {
try {
Airline airline = airlineService.getAirlineById(id);
if (airline != null) {
Expand All @@ -62,8 +69,14 @@ public ResponseEntity<Airline> getAirline(@PathVariable String id) {
}

@PostMapping("/{id}")
@Operation(summary = "Create an airline")
@Description(value = "Create Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to create a new document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `createAirline`")
@Operation(summary = "Create an airline", description = "Create Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to create a new document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/main/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `createAirline`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Airline created"),
@ApiResponse(responseCode = "409", description = "Airline already exists"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "id", description = "Airline ID", required = true, example = "airline_10")
public ResponseEntity<Airline> createAirline(@PathVariable String id, @Valid @RequestBody Airline airline) {
try {
Airline newAirline = airlineService.createAirline(airline);
Expand All @@ -79,8 +92,14 @@ public ResponseEntity<Airline> createAirline(@PathVariable String id, @Valid @Re
}

@PutMapping("/{id}")
@Operation(summary = "Update an airline")
@Description(value = "Update Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to update a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `updateAirline`")
@Operation(summary = "Update an airline", description = "Update Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to update a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/main/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `updateAirline`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Airline updated"),
@ApiResponse(responseCode = "404", description = "Airline not found"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "id", description = "Airline ID", required = true, example = "airline_10")
public ResponseEntity<Airline> updateAirline(@PathVariable String id, @Valid @RequestBody Airline airline) {
try {
Airline updatedAirline = airlineService.updateAirline(id, airline);
Expand All @@ -99,8 +118,14 @@ public ResponseEntity<Airline> updateAirline(@PathVariable String id, @Valid @Re
}

@DeleteMapping("/{id}")
@Operation(summary = "Delete an airline")
@Description(value = "Delete Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to delete a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `deleteAirline`")
@Operation(summary = "Delete an airline", description = "Delete Airport with specified ID.\n\nThis provides an example of using Key Value operations in Couchbase to delete a document with a specified ID. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/main/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `deleteAirline`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Airline deleted"),
@ApiResponse(responseCode = "404", description = "Airline not found"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "id", description = "Airline ID", required = true, example = "airline_10")
public ResponseEntity<Void> deleteAirline(@PathVariable String id) {
try {
airlineService.deleteAirline(id);
Expand All @@ -115,40 +140,40 @@ public ResponseEntity<Void> deleteAirline(@PathVariable String id) {
}

@GetMapping("/list")
@Operation(summary = "List all airlines")
@Description(value = "List all Airports.\n\nThis provides an example of using N1QL to query all documents of a specific type. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `listAirlines`")
public ResponseEntity<List<Airline>> listAirlines(
@Operation(summary = "List all airlines by country", description = "List all Airports by country.\n\nThis provides an example of using N1QL to query all documents of a specific type by a specific field. \n\n Code: `controllers/AirlineController.java` \n File: `AirlineController.java` \n Method: `listAirlinesByCountry`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Airlines found"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "country", description = "Country", required = false, example = "United States")
public ResponseEntity<List<Airline>> listAirlinesByCountry(@RequestParam(required = false) String country,
@RequestParam(defaultValue = "10") int limit,
@RequestParam(defaultValue = "0") int offset) {
try {
List<Airline> airlines = airlineService.listAirlines(limit, offset);
return new ResponseEntity<>(airlines, HttpStatus.OK);
} catch (Exception e) {
log.error(INTERNAL_SERVER_ERROR + ": " + e.getMessage());
return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}
}

@Operation(summary = "List all airlines by country")
@GetMapping("/country/{country}")
@Description(value = "List all Airports by country.\n\nThis provides an example of using N1QL to query all documents of a specific type by a specific field. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `listAirlinesByCountry`")
public ResponseEntity<List<Airline>> listAirlinesByCountry(@PathVariable String country,
@RequestParam(defaultValue = "10") int limit,
@RequestParam(defaultValue = "0") int offset) {
try {
List<Airline> airlines = airlineService.listAirlinesByCountry(country, limit, offset);
List<Airline> airlines;
if (country == null || country.isEmpty()) {
airlines = airlineService.listAirlines(limit, offset);
} else {
airlines = airlineService.listAirlinesByCountry(country, limit, offset);
}
return new ResponseEntity<>(airlines, HttpStatus.OK);
} catch (Exception e) {
log.error(INTERNAL_SERVER_ERROR + ": " + e.getMessage());
return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}
}

@Operation(summary = "List all airlines by destination airport")
@GetMapping("/destination/{destinationAirport}")
@Description(value = "List all Airports by destination airport.\n\nThis provides an example of using N1QL to query all documents of a specific type by a specific field. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/master/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `listAirlinesByDestinationAirport`")
@GetMapping("/to-airport")
@Operation(summary = "List all airlines by destination airport", description = "List all Airports by destination airport.\n\nThis provides an example of using N1QL to query all documents of a specific type by a specific field. \n\n Code: [`controllers/AirlineController.java`](https://github.com/couchbase-examples/java-springboot-quickstart/blob/main/src/main/java/org/couchbase/quickstart/springboot/controllers/AirlineController.java) \n File: `AirlineController.java` \n Method: `listAirlinesByDestinationAirport`", tags = {
"Airline" })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Airlines found"),
@ApiResponse(responseCode = "500", description = "Internal Server Error")
})
@Parameter(name = "destinationAirport", description = "Destination Airport", required = true, example = "SFO")
public ResponseEntity<List<Airline>> listAirlinesByDestinationAirport(
@PathVariable String destinationAirport,
@RequestParam(required = true) String destinationAirport,
@RequestParam(defaultValue = "10") int limit,
@RequestParam(defaultValue = "0") int offset) {
try {
Expand Down
Loading