Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

Commit 3b9560c

Browse files
davidfowlReubenBond
davidfowl
and
ReubenBond
authored
Clean up usings and controller attributes (#2124)
* Clean up usings and controller attributes - Removed redundant attributes when the controllers already specifies what the result type is. - Use StatusCodes instead of HttpStatusCode. - Clean up namespaces and use type aliases to disambiguate the many DTOs defined. * Forgot one * Update src/Services/Webhooks/Webhooks.API/Controllers/WebhooksController.cs Co-authored-by: Reuben Bond <[email protected]> --------- Co-authored-by: Reuben Bond <[email protected]>
1 parent c7c2d1c commit 3b9560c

File tree

17 files changed

+47
-98
lines changed

17 files changed

+47
-98
lines changed

‎src/ApiGateways/Mobile.Bff.Shopping/aggregator/Controllers/BasketController.cs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ public BasketController(ICatalogService catalogService, IBasketService basketSer
1616

1717
[HttpPost]
1818
[HttpPut]
19-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
20-
[ProducesResponseType(typeof(BasketData), (int)HttpStatusCode.OK)]
19+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
2120
public async Task<ActionResult<BasketData>> UpdateAllBasketAsync([FromBody] UpdateBasketRequest data)
2221
{
2322
if (data.Items == null || !data.Items.Any())
@@ -73,8 +72,7 @@ public async Task<ActionResult<BasketData>> UpdateAllBasketAsync([FromBody] Upda
7372

7473
[HttpPut]
7574
[Route("items")]
76-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
77-
[ProducesResponseType(typeof(BasketData), (int)HttpStatusCode.OK)]
75+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
7876
public async Task<ActionResult<BasketData>> UpdateQuantitiesAsync([FromBody] UpdateBasketItemsRequest data)
7977
{
8078
if (!data.Updates.Any())
@@ -110,8 +108,8 @@ public async Task<ActionResult<BasketData>> UpdateQuantitiesAsync([FromBody] Upd
110108

111109
[HttpPost]
112110
[Route("items")]
113-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
114-
[ProducesResponseType((int)HttpStatusCode.OK)]
111+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
112+
[ProducesResponseType(StatusCodes.Status200OK)]
115113
public async Task<ActionResult> AddBasketItemAsync([FromBody] AddBasketItemRequest data)
116114
{
117115
if (data == null || data.Quantity == 0)

‎src/ApiGateways/Mobile.Bff.Shopping/aggregator/Controllers/HomeController.cs‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎src/ApiGateways/Mobile.Bff.Shopping/aggregator/Controllers/OrderController.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ public OrderController(IBasketService basketService, IOrderingService orderingSe
1616

1717
[Route("draft/{basketId}")]
1818
[HttpGet]
19-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
20-
[ProducesResponseType(typeof(OrderData), (int)HttpStatusCode.OK)]
19+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
2120
public async Task<ActionResult<OrderData>> GetOrderDraftAsync(string basketId)
2221
{
2322
if (string.IsNullOrEmpty(basketId))

‎src/ApiGateways/Mobile.Bff.Shopping/aggregator/GlobalUsings.cs‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@
22
global using Grpc.Core.Interceptors;
33
global using Grpc.Core;
44
global using GrpcBasket;
5-
global using HealthChecks.UI.Client;
6-
global using Microsoft.AspNetCore.Authentication.JwtBearer;
7-
global using Microsoft.AspNetCore.Authentication;
85
global using Microsoft.AspNetCore.Authorization;
96
global using Microsoft.AspNetCore.Builder;
10-
global using Microsoft.AspNetCore.Diagnostics.HealthChecks;
117
global using Microsoft.AspNetCore.Http;
128
global using Microsoft.AspNetCore.Mvc;
139
global using Microsoft.eShopOnContainers.Mobile.Shopping.HttpAggregator.Config;
@@ -16,19 +12,13 @@
1612
global using Microsoft.eShopOnContainers.Mobile.Shopping.HttpAggregator.Services;
1713
global using Microsoft.Extensions.Configuration;
1814
global using Microsoft.Extensions.DependencyInjection;
19-
global using Microsoft.Extensions.Diagnostics.HealthChecks;
2015
global using Microsoft.Extensions.Logging;
2116
global using Microsoft.Extensions.Options;
22-
global using Microsoft.OpenApi.Models;
2317
global using System.Collections.Generic;
24-
global using System.IdentityModel.Tokens.Jwt;
2518
global using System.Linq;
26-
global using System.Net.Http.Headers;
2719
global using System.Net.Http;
2820
global using System.Net;
2921
global using System.Text.Json;
3022
global using System.Threading.Tasks;
31-
global using System.Threading;
3223
global using System;
33-
global using Microsoft.IdentityModel.Tokens;
3424
global using Services.Common;

‎src/ApiGateways/Web.Bff.Shopping/aggregator/Controllers/BasketController.cs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ public BasketController(ICatalogService catalogService, IBasketService basketSer
1616

1717
[HttpPost]
1818
[HttpPut]
19-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
20-
[ProducesResponseType(typeof(BasketData), (int)HttpStatusCode.OK)]
19+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
2120
public async Task<ActionResult<BasketData>> UpdateAllBasketAsync([FromBody] UpdateBasketRequest data)
2221
{
2322
if (data.Items == null || !data.Items.Any())
@@ -74,8 +73,7 @@ public async Task<ActionResult<BasketData>> UpdateAllBasketAsync([FromBody] Upda
7473

7574
[HttpPut]
7675
[Route("items")]
77-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
78-
[ProducesResponseType(typeof(BasketData), (int)HttpStatusCode.OK)]
76+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
7977
public async Task<ActionResult<BasketData>> UpdateQuantitiesAsync([FromBody] UpdateBasketItemsRequest data)
8078
{
8179
if (!data.Updates.Any())
@@ -109,8 +107,8 @@ public async Task<ActionResult<BasketData>> UpdateQuantitiesAsync([FromBody] Upd
109107

110108
[HttpPost]
111109
[Route("items")]
112-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
113-
[ProducesResponseType((int)HttpStatusCode.OK)]
110+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
111+
[ProducesResponseType(StatusCodes.Status200OK)]
114112
public async Task<ActionResult> AddBasketItemAsync([FromBody] AddBasketItemRequest data)
115113
{
116114
if (data == null || data.Quantity == 0)

‎src/ApiGateways/Web.Bff.Shopping/aggregator/Controllers/OrderController.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ public OrderController(IBasketService basketService, IOrderingService orderingSe
1616

1717
[Route("draft/{basketId}")]
1818
[HttpGet]
19-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
20-
[ProducesResponseType(typeof(OrderData), (int)HttpStatusCode.OK)]
19+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
2120
public async Task<ActionResult<OrderData>> GetOrderDraftAsync(string basketId)
2221
{
2322
if (string.IsNullOrWhiteSpace(basketId))

‎src/Services/Basket/Basket.API/BasketSettings.cs‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎src/Services/Basket/Basket.API/Controllers/BasketController.cs‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ public BasketController(
2323
}
2424

2525
[HttpGet("{id}")]
26-
[ProducesResponseType(typeof(CustomerBasket), (int)HttpStatusCode.OK)]
2726
public async Task<ActionResult<CustomerBasket>> GetBasketByIdAsync(string id)
2827
{
2928
var basket = await _repository.GetBasketAsync(id);
@@ -32,16 +31,15 @@ public async Task<ActionResult<CustomerBasket>> GetBasketByIdAsync(string id)
3231
}
3332

3433
[HttpPost]
35-
[ProducesResponseType(typeof(CustomerBasket), (int)HttpStatusCode.OK)]
3634
public async Task<ActionResult<CustomerBasket>> UpdateBasketAsync([FromBody] CustomerBasket value)
3735
{
3836
return Ok(await _repository.UpdateBasketAsync(value));
3937
}
4038

4139
[Route("checkout")]
4240
[HttpPost]
43-
[ProducesResponseType((int)HttpStatusCode.Accepted)]
44-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
41+
[ProducesResponseType(StatusCodes.Status202Accepted)]
42+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
4543
public async Task<ActionResult> CheckoutAsync([FromBody] BasketCheckout basketCheckout, [FromHeader(Name = "x-requestid")] string requestId)
4644
{
4745
var userId = _identityService.GetUserIdentity();
@@ -81,7 +79,7 @@ public async Task<ActionResult> CheckoutAsync([FromBody] BasketCheckout basketCh
8179

8280
// DELETE api/values/5
8381
[HttpDelete("{id}")]
84-
[ProducesResponseType(typeof(void), (int)HttpStatusCode.OK)]
82+
[ProducesResponseType(StatusCodes.Status200OK)]
8583
public async Task DeleteBasketByIdAsync(string id)
8684
{
8785
await _repository.DeleteBasketAsync(id);

‎src/Services/Basket/Basket.API/GlobalUsings.cs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
global using System.Collections.Generic;
33
global using System.ComponentModel.DataAnnotations;
44
global using System.Linq;
5-
global using System.Net;
65
global using System.Security.Claims;
76
global using System.Text.Json;
87
global using System.Threading.Tasks;

‎src/Services/Catalog/Catalog.API/Controllers/CatalogController.cs‎

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ public CatalogController(CatalogContext context, IOptionsSnapshot<CatalogSetting
2020
// GET api/v1/[controller]/items[?pageSize=3&pageIndex=10]
2121
[HttpGet]
2222
[Route("items")]
23-
[ProducesResponseType(typeof(PaginatedItemsViewModel<CatalogItem>), (int)HttpStatusCode.OK)]
24-
[ProducesResponseType(typeof(IEnumerable<CatalogItem>), (int)HttpStatusCode.OK)]
25-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
23+
[ProducesResponseType(typeof(PaginatedItemsViewModel<CatalogItem>), StatusCodes.Status200OK)]
24+
[ProducesResponseType(typeof(IEnumerable<CatalogItem>), StatusCodes.Status200OK)]
25+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
2626
public async Task<IActionResult> ItemsAsync([FromQuery] int pageSize = 10, [FromQuery] int pageIndex = 0, string ids = null)
2727
{
2828
if (!string.IsNullOrEmpty(ids))
@@ -74,9 +74,8 @@ private async Task<List<CatalogItem>> GetItemsByIdsAsync(string ids)
7474

7575
[HttpGet]
7676
[Route("items/{id:int}")]
77-
[ProducesResponseType((int)HttpStatusCode.NotFound)]
78-
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
79-
[ProducesResponseType(typeof(CatalogItem), (int)HttpStatusCode.OK)]
77+
[ProducesResponseType(StatusCodes.Status404NotFound)]
78+
[ProducesResponseType(StatusCodes.Status400BadRequest)]
8079
public async Task<ActionResult<CatalogItem>> ItemByIdAsync(int id)
8180
{
8281
if (id <= 0)
@@ -102,7 +101,6 @@ public async Task<ActionResult<CatalogItem>> ItemByIdAsync(int id)
102101
// GET api/v1/[controller]/items/withname/samplename[?pageSize=3&pageIndex=10]
103102
[HttpGet]
104103
[Route("items/withname/{name:minlength(1)}")]
105-
[ProducesResponseType(typeof(PaginatedItemsViewModel<CatalogItem>), (int)HttpStatusCode.OK)]
106104
public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsWithNameAsync(string name, [FromQuery] int pageSize = 10, [FromQuery] int pageIndex = 0)
107105
{
108106
var totalItems = await _catalogContext.CatalogItems
@@ -123,7 +121,6 @@ public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsWithN
123121
// GET api/v1/[controller]/items/type/1/brand[?pageSize=3&pageIndex=10]
124122
[HttpGet]
125123
[Route("items/type/{catalogTypeId}/brand/{catalogBrandId:int?}")]
126-
[ProducesResponseType(typeof(PaginatedItemsViewModel<CatalogItem>), (int)HttpStatusCode.OK)]
127124
public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsByTypeIdAndBrandIdAsync(int catalogTypeId, int? catalogBrandId, [FromQuery] int pageSize = 10, [FromQuery] int pageIndex = 0)
128125
{
129126
var root = (IQueryable<CatalogItem>)_catalogContext.CatalogItems;
@@ -151,7 +148,6 @@ public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsByTyp
151148
// GET api/v1/[controller]/items/type/all/brand[?pageSize=3&pageIndex=10]
152149
[HttpGet]
153150
[Route("items/type/all/brand/{catalogBrandId:int?}")]
154-
[ProducesResponseType(typeof(PaginatedItemsViewModel<CatalogItem>), (int)HttpStatusCode.OK)]
155151
public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsByBrandIdAsync(int? catalogBrandId, [FromQuery] int pageSize = 10, [FromQuery] int pageIndex = 0)
156152
{
157153
var root = (IQueryable<CatalogItem>)_catalogContext.CatalogItems;
@@ -177,7 +173,6 @@ public async Task<ActionResult<PaginatedItemsViewModel<CatalogItem>>> ItemsByBra
177173
// GET api/v1/[controller]/CatalogTypes
178174
[HttpGet]
179175
[Route("catalogtypes")]
180-
[ProducesResponseType(typeof(List<CatalogType>), (int)HttpStatusCode.OK)]
181176
public async Task<ActionResult<List<CatalogType>>> CatalogTypesAsync()
182177
{
183178
return await _catalogContext.CatalogTypes.ToListAsync();
@@ -186,7 +181,6 @@ public async Task<ActionResult<List<CatalogType>>> CatalogTypesAsync()
186181
// GET api/v1/[controller]/CatalogBrands
187182
[HttpGet]
188183
[Route("catalogbrands")]
189-
[ProducesResponseType(typeof(List<CatalogBrand>), (int)HttpStatusCode.OK)]
190184
public async Task<ActionResult<List<CatalogBrand>>> CatalogBrandsAsync()
191185
{
192186
return await _catalogContext.CatalogBrands.ToListAsync();
@@ -195,8 +189,8 @@ public async Task<ActionResult<List<CatalogBrand>>> CatalogBrandsAsync()
195189
//PUT api/v1/[controller]/items
196190
[Route("items")]
197191
[HttpPut]
198-
[ProducesResponseType((int)HttpStatusCode.NotFound)]
199-
[ProducesResponseType((int)HttpStatusCode.Created)]
192+
[ProducesResponseType(StatusCodes.Status404NotFound)]
193+
[ProducesResponseType(StatusCodes.Status201Created)]
200194
public async Task<ActionResult> UpdateProductAsync([FromBody] CatalogItem productToUpdate)
201195
{
202196
var catalogItem = await _catalogContext.CatalogItems.SingleOrDefaultAsync(i => i.Id == productToUpdate.Id);
@@ -235,7 +229,7 @@ public async Task<ActionResult> UpdateProductAsync([FromBody] CatalogItem produc
235229
//POST api/v1/[controller]/items
236230
[Route("items")]
237231
[HttpPost]
238-
[ProducesResponseType((int)HttpStatusCode.Created)]
232+
[ProducesResponseType(StatusCodes.Status201Created)]
239233
public async Task<ActionResult> CreateProductAsync([FromBody] CatalogItem product)
240234
{
241235
var item = new CatalogItem
@@ -258,8 +252,8 @@ public async Task<ActionResult> CreateProductAsync([FromBody] CatalogItem produc
258252
//DELETE api/v1/[controller]/id
259253
[Route("{id}")]
260254
[HttpDelete]
261-
[ProducesResponseType((int)HttpStatusCode.NoContent)]
262-
[ProducesResponseType((int)HttpStatusCode.NotFound)]
255+
[ProducesResponseType(StatusCodes.Status204NoContent)]
256+
[ProducesResponseType(StatusCodes.Status404NotFound)]
263257
public async Task<ActionResult> DeleteProductAsync(int id)
264258
{
265259
var product = _catalogContext.CatalogItems.SingleOrDefault(x => x.Id == id);

0 commit comments

Comments
 (0)