Skip to content

Feature/task4745 #381

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Feature/task4745 #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a05a43
task4745-Refactor Swagger annotations to reduce duplication
Jul 15, 2022
c28d60a
fix the format
Jul 15, 2022
1a8dc1a
fix the format
Jul 15, 2022
f6ea9eb
fix some comments
Jul 15, 2022
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
13 changes: 2 additions & 11 deletions java/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
<groupId>com.amido.stacks.workloads</groupId>
<artifactId>stacks-api-cqrs</artifactId>
<version>1.0.0</version>
<name>stacks-api-cqrs</name>
<name>${project.groupId}:${project.artifactId}</name>
<description>Demo project for Java with CQRS</description>

<properties>
<!-- Stacks versions -->
<stacks.core.commons.version>1.0.3</stacks.core.commons.version>
<stacks.core.api.version>1.0.0</stacks.core.api.version>
<stacks.core.api.version>1.0.2.2-RELEASE</stacks.core.api.version>
<stacks.azure.cosmos.version>1.0.0</stacks.azure.cosmos.version>
<stacks.core.cqrs.version>1.0.0</stacks.core.cqrs.version>

Expand Down Expand Up @@ -69,15 +69,6 @@

</properties>

<repositories>
<repository>
<snapshots/>
<id>snapshots</id>
<name>default-maven-virtual</name>
<url>https://amidostacks.jfrog.io/artifactory/default-maven-virtual</url>
</repository>
</repositories>

<dependencyManagement>
<dependencies>
<dependency>
Expand Down
65 changes: 17 additions & 48 deletions java/src/main/java/com/amido/stacks/workloads/menu/api/v1/CreateCategoryController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,35 @@
package com.amido.stacks.workloads.menu.api.v1;

import com.amido.stacks.core.api.dto.ErrorResponse;
import com.amido.stacks.core.api.annotations.CreateAPIResponses;
import com.amido.stacks.core.api.dto.response.ResourceCreatedResponse;
import com.amido.stacks.workloads.menu.api.v1.dto.request.CreateCategoryRequest;
import com.amido.stacks.workloads.menu.api.v1.dto.response.ResourceCreatedResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import java.util.UUID;
import javax.validation.Valid;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@RequestMapping("/v1/menu/{id}/category")
@RequestMapping(
path = "/v1/menu/{id}/category",
consumes = MediaType.APPLICATION_JSON_VALUE,
produces = MediaType.APPLICATION_JSON_VALUE + "; charset=utf-8",
method = RequestMethod.POST)
public interface CreateCategoryController {

@PostMapping(consumes = "application/json", produces = "application/json; charset=utf-8")
@PostMapping
@Operation(
tags = "Category",
summary = "Create a category in the menu",
security = @SecurityRequirement(name = "bearerAuth"),
description = "Adds a category to menu",
operationId = "AddMenuCategory",
responses = {
@ApiResponse(
responseCode = "201",
description = "Resource created",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ResourceCreatedResponse.class))),
@ApiResponse(
responseCode = "400",
description = "Bad Request",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "401",
description = "Unauthorized, Access token is missing or invalid",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "403",
description = "Forbidden, the user does not have permission to execute this operation",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "409",
description = "Conflict, an item already exists",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class)))
})
operationId = "AddMenuCategory")
@CreateAPIResponses
ResponseEntity<ResourceCreatedResponse> addMenuCategory(
@Parameter(description = "Menu id", required = true) @PathVariable("id") UUID menuId,
@Valid @RequestBody CreateCategoryRequest body,
Expand Down
65 changes: 17 additions & 48 deletions java/src/main/java/com/amido/stacks/workloads/menu/api/v1/CreateItemController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,35 @@
package com.amido.stacks.workloads.menu.api.v1;

import com.amido.stacks.core.api.dto.ErrorResponse;
import com.amido.stacks.core.api.annotations.CreateAPIResponses;
import com.amido.stacks.core.api.dto.response.ResourceCreatedResponse;
import com.amido.stacks.workloads.menu.api.v1.dto.request.CreateItemRequest;
import com.amido.stacks.workloads.menu.api.v1.dto.response.ResourceCreatedResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import java.util.UUID;
import javax.validation.Valid;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@RequestMapping("/v1/menu/{id}/category/{categoryId}/items")
@RequestMapping(
path = "/v1/menu/{id}/category/{categoryId}/items",
consumes = MediaType.APPLICATION_JSON_VALUE,
produces = MediaType.APPLICATION_JSON_VALUE + "; charset=utf-8",
method = RequestMethod.POST)
public interface CreateItemController {

@PostMapping(consumes = "application/json", produces = "application/json; charset=utf-8")
@PostMapping
@Operation(
tags = "Item",
summary = "Add an item to an existing category in a menu",
security = @SecurityRequirement(name = "bearerAuth"),
description = "Adds a menu item",
operationId = "AddMenuItem",
responses = {
@ApiResponse(
responseCode = "201",
description = "Resource created",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ResourceCreatedResponse.class))),
@ApiResponse(
responseCode = "400",
description = "Bad Request",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "401",
description = "Unauthorized, Access token is missing or invalid",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "403",
description = "Forbidden, the user does not have permission to execute this operation",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "409",
description = "Conflict, an item already exists",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class)))
})
operationId = "AddMenuItem")
@CreateAPIResponses
ResponseEntity<ResourceCreatedResponse> addMenuItem(
@Parameter(description = "Menu id", required = true) @PathVariable("id") UUID menuId,
@Parameter(description = "Category id", required = true) @PathVariable("categoryId")
Expand Down
59 changes: 12 additions & 47 deletions java/src/main/java/com/amido/stacks/workloads/menu/api/v1/CreateMenuController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,33 @@
package com.amido.stacks.workloads.menu.api.v1;

import com.amido.stacks.core.api.dto.ErrorResponse;
import com.amido.stacks.core.api.annotations.CreateAPIResponses;
import com.amido.stacks.core.api.dto.response.ResourceCreatedResponse;
import com.amido.stacks.workloads.menu.api.v1.dto.request.CreateMenuRequest;
import com.amido.stacks.workloads.menu.api.v1.dto.response.ResourceCreatedResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import javax.validation.Valid;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@RequestMapping("/v1/menu")
@RequestMapping(
path = "/v1/menu",
consumes = MediaType.APPLICATION_JSON_VALUE,
produces = MediaType.APPLICATION_JSON_VALUE + " ; charset=utf-8",
method = RequestMethod.POST)
public interface CreateMenuController {

@PostMapping(consumes = "application/json", produces = "application/json; charset=utf-8")
@PostMapping
@Operation(
tags = "Menu",
summary = "Create a menu",
security = @SecurityRequirement(name = "bearerAuth"),
description = "Adds a menu",
operationId = "CreateMenu",
responses = {
@ApiResponse(
responseCode = "201",
description = "Resource created",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ResourceCreatedResponse.class))),
@ApiResponse(
responseCode = "400",
description = "Bad Request",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "401",
description = "Unauthorized, Access token is missing or invalid",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "403",
description = "Forbidden, the user does not have permission to execute this operation",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "409",
description = "Conflict, an item already exists",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class)))
})
operationId = "CreateMenu")
@CreateAPIResponses
ResponseEntity<ResourceCreatedResponse> createMenu(
@Valid @RequestBody CreateMenuRequest body,
@Parameter(hidden = true) @RequestAttribute("CorrelationId") String correlationId);
Expand Down
57 changes: 10 additions & 47 deletions java/src/main/java/com/amido/stacks/workloads/menu/api/v1/DeleteCategoryController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,67 +1,30 @@
package com.amido.stacks.workloads.menu.api.v1;

import com.amido.stacks.core.api.dto.ErrorResponse;
import com.amido.stacks.core.api.annotations.DeleteAPIResponses;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import java.util.UUID;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@RequestMapping("/v1/menu/{id}/category/{categoryId}")
@RequestMapping(
path = "/v1/menu/{id}/category/{categoryId}",
produces = MediaType.APPLICATION_JSON_VALUE + "; charset=utf-8",
method = RequestMethod.DELETE)
public interface DeleteCategoryController {

@DeleteMapping(produces = "application/json; charset=utf-8")
@DeleteMapping
@Operation(
tags = "Category",
summary = "Removes a category and its items from menu",
security = @SecurityRequirement(name = "bearerAuth"),
description = "Removes a category and its items from menu",
operationId = "DeleteCategory",
responses = {
@ApiResponse(
responseCode = "200",
description = "Success",
content = @Content(mediaType = "application/json", schema = @Schema(hidden = true))),
@ApiResponse(
responseCode = "204",
description = "No Content",
content = @Content(schema = @Schema(hidden = true))),
@ApiResponse(
responseCode = "400",
description = "Bad Request",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "401",
description = "Unauthorized, Access token is missing or invalid",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "403",
description = "Forbidden, the user does not have permission to execute this operation",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class))),
@ApiResponse(
responseCode = "409",
description = "Conflict, an item already exists",
content =
@Content(
mediaType = "application/json",
schema = @Schema(implementation = ErrorResponse.class)))
})
operationId = "DeleteCategory")
@DeleteAPIResponses
ResponseEntity<Void> deleteCategory(
@Parameter(description = "Menu id", required = true) @PathVariable("id") UUID menuId,
@Parameter(description = "Category id", required = true) @PathVariable("categoryId")
Expand Down
Loading