Summary

Sample project needs to be prepared and EasyWeb libraries should be used.

Codacy detected an issue:

Message: Remove the array type; it is redundant.

Occurred on:

• Commit: e0fc048
• File: src/EasyWeb.AspNetCore.Swagger/Filters/BearerSecurityDocumentFilter.cs
• LineNum: 24
• Code: requirement.Add(scheme, new string[] { "Bearer" });

Currently on:

• Commit: 4dd106d
• File: src/EasyWeb.AspNetCore.Swagger/Filters/BearerSecurityDocumentFilter.cs
• LineNum: 37

Codacy detected an issue:

Message: Add curly braces around the nested statement(s) in this 'if' block.

Occurred on:

• Commit: b0570af
• File: src/EasyWeb.AspNetCore/Controllers/BaseApiController.cs
• LineNum: 254
• Code: if (value == null)

Currently on:

• Commit: 4dd106d
• File: src/EasyWeb.AspNetCore/Controllers/BaseApiController.cs
• LineNum: 254

Codacy detected an issue:

Message: Use absolute WORKDIR

Occurred on:

• Commit: 3398377
• File: Dockerfile
• LineNum: 19
• Code: WORKDIR "/src/sample/EasyWeb.Demo"

Currently on:

• Commit: 4dd106d
• File: Dockerfile
• LineNum: 19

Summary

The standard operations included in each api project should reside in a single solution.

These operations are;

• HttpContextAccessor
• Memory Cache
• Response Caching
• Api Versioning

Summary

For Web API projects, the most used swagger implementation among API documentation tools should be implemented.

Filters that should be in a standard API should be added and configuration extension methods should be completed.

These filters are;

• Authorization Operation Filter
• Bearer Security Operation Filter
• Camel Case Document Filter
• Content Type Operation Filter
• Default Values Operation Filter

Codacy detected an issue:

Message: Add curly braces around the nested statement(s) in this 'foreach' block.

Occurred on:

• Commit: 34941e0
• File: src/EasyWeb.AspNetCore.Swagger/Program.cs
• LineNum: 92
• Code: foreach (var description in versioningProvider.ApiVersionDescriptions)

Currently on:

• Commit: 4dd106d
• File: src/EasyWeb.AspNetCore.Swagger/Program.cs
• LineNum: 82

Summary

This issue includes the following responsibilities;

• A standard Web Api consists of a static API schema.
• DATA : It contains response data transfer objects.
• Key: It contains operational-based keywords.
• Meta: It contains meta information on endpoint basis, such as pagination information.
• Success : reports whether the operation was successful or not.
• IsUserFriendlyMessage : If there is a user-friendly message at the end of the operation, it includes this message.

Summary

Model Validation must be common.
All models should be validated on an endpoint basis.

An actionFilter must be created for this operation.

It should be common to all endpoints.

Summary

Publishing the Sample project on heroku.

CodeFactor found an issue: A closing curly bracket must not be preceded by a blank line.

It's currently on:
src\EasyWeb.Core\Models\ApiResult{TData,TMeta}.cs:44

Summary

All endpoints must inherit from a common base class.

This base class should override the following methods.

• OK
• CreatedAtAction
• Created
• Accepted
• AcceptedAtAction
• BadRequest