neosoft-technologies / rest-dot-net-core Goto Github PK

^{Originally posted by sasachan August 5, 2021}
APIs only need to be up-versioned when a breaking change is made. Breaking changes include:

• a change in the format of the response data for one or more calls
• a change in the request or response type (i.e. changing an integer to a float)
• removing any part of the API.

Breaking changes should always result in a change to the major version number for an API or content response type.

Non-breaking changes, such as adding new endpoints or new response parameters, do not require a change to the major version number. However, it can be helpful to track the minor versions of APIs when changes are made to support customers who may be receiving cached versions of data or may be experiencing other API issues.

https://www.baeldung.com/rest-versioning

^{Originally posted by shreedhar-ww August 5, 2021}
Environmental variable integration

^{Originally posted by apoorv-neosofttech August 27, 2021}
JWT Refresh Token

^{Originally posted by sasachan August 5, 2021}
Serilog is a diagnostic logging library for .NET applications. It is easy to set up, has a clean API, and runs on all recent .NET platforms. While it's useful even in the simplest applications, Serilog's support for structured logging shines when instrumenting complex, distributed, and asynchronous applications and systems.

https://github.com/serilog/serilog

^{Originally posted by sasachan August 13, 2021}
Best practice reference

• FunctionalTests
• UnitTests

https://github.com/dotnet-architecture/eShopOnContainers/tree/dev/src/Services/Basket

My advice to use breakdown the test as https://devblogs.microsoft.com/bharry/testing-in-a-cloud-delivery-cadence/

L0, L1 and L2

^{Originally posted by shreedhar-ww August 26, 2021}
Code Smells and Security Hotspots fixes

^{Originally posted by apoorv-neosofttech August 26, 2021}
Support for exporting CSV

^{Originally posted by sasachan July 29, 2021}
Add support for swagger

^{Originally posted by sasachan August 10, 2021}
Custom item template should help to add new controller

^{Originally posted by nehaharidasneo August 5, 2021}
Many a times we tend to hardcode the application alerts or messages in the code. many a times they are conditional as well. Typically in API we need this as then the client will not have to take care of these alerts. Also need to check the way if we can read it from a file or a json so that any change in the string will not need a deployment

^{Originally posted by dwivedi-ankita September 1, 2021}
Description and Content for following modules,

• VSIX
• Project Setup
• DB-Setup
• Swagger
• Authentication
• Refresh Token
• Logger
• Version-Control
• HealthCheck
• Request-Response
• Email
• CSV download

^{Originally posted by apoorv-neosofttech August 26, 2021}
JWT Role Based Authorization

^{Originally posted by sasachan July 29, 2021}
Add support for swagger

^{Originally posted by shreedhar-ww August 26, 2021}
code coverage sonar Qube integration

^{Originally posted by sasachan August 5, 2021}
https://docs.microsoft.com/en-us/learn/modules/integrate-openapi-enabled-web-api-with-apim-and-visual-studio/3-exercise-activate-openapi-to-web-api-using-swashbuckle

Add Swagger and Swagger UI to an ASP.NET Core web API application. The Swagger tooling will assist in creating the OpenAPI document describing your web API

^{Originally posted by sasachan August 13, 2021}
Best practice reference

• FunctionalTests
• UnitTests

https://github.com/dotnet-architecture/eShopOnContainers/tree/dev/src/Services/Basket

My advice to use breakdown the test as https://devblogs.microsoft.com/bharry/testing-in-a-cloud-delivery-cadence/

L0, L1 and L2

^{Originally posted by sasachan August 13, 2021}
CI using Git-Actions (cloud version)

• Build Code
• (Test) Run UnitTest
• (Test) Run Vulnerability scanning
• (Test) Run Static Code Analysis
• • Publish code analysis to sonar
• (Test) Run acceptable testing(may be done in the future)

Extending feedback from @nehaharidasneo #66(CI).

^{Originally posted by sasachan August 5, 2021}
https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions

^{Originally posted by sasachan August 5, 2021}
The Developer Exception Page is a useful tool to get detailed stack traces for server errors. It uses DeveloperExceptionPageMiddleware to capture synchronous and asynchronous exceptions from the HTTP pipeline and to generate error responses.

https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-5.0

^{Originally posted by shreedhar-ww August 5, 2021}
DB health-check
External service
Email

^{Originally posted by nehaharidasneo August 5, 2021}

• URL encoding/decoding
• Password encryption helper
• config files encryption/decryption
• Antiforgerytoken
• Application Assets links to be encrypted/authenticated

^{Originally posted by sasachan August 10, 2021}
Custom item template should help to add new controller

^{Originally posted by sasachan August 5, 2021}
Use Clean Architecture solution, each project has clear responsibilities. As such, certain types belong in each project and you’ll frequently find folders corresponding to these types in the appropriate project.

https://github.com/jasontaylordev/CleanArchitecture
https://github.com/ardalis/CleanArchitecture
https://github.com/iammukeshm/CleanArchitecture.WebApi
https://github.com/ivanpaulovich/clean-architecture-manga
https://github.com/Amitpnk/Clean-Architecture-ASP.NET-Core
https://github.com/jasontaylordev/NorthwindTraders
https://github.com/thangchung/clean-code-dotnet

^{Originally posted by sasachan August 9, 2021}
Standards for REST API business validation and setup

^{Originally posted by sasachan August 13, 2021}
Setup repository folder/source code structure as https://github.com/dotnet-architecture/eShopOnContainers

Specially

• Build
• Deploy
• Src
• Docs
• Others CONTRIBUTING.md.md, README.md, branch-guid.me, github-actions.md
• LICENSE
• .gitattributes
• .gitignore

^{Originally posted by sasachan August 10, 2021}
https://docs.microsoft.com/en-us/visualstudio/extensibility/creating-custom-project-and-item-templates?view=vs-2019

^{Originally posted by dwivedi-ankita September 1, 2021}

Wiki Page Setup for following modules,

• VSIX
• Project Setup
• DB-Setup
• Swagger
• Authentication
• Refresh Token
• Logger
• Version-Control
• HealthCheck
• Polly
• Request-Response
• Email
• N-swag
• CSV download

Automated test
Flow of Control
Architectural principles
Clean Architecture Layers(Design constructs)
Environment Configurations
DevOps

^{Originally posted by sasachan August 13, 2021}
CI using Git-Actions (cloud version)

• Build Code
• (Test) Run UnitTest
• (Test) Run Vulnerability scanning
• (Test) Run Static Code Analysis
• • Publish code analysis to sonar
• (Test) Run acceptable testing(may be done in the future)

Extending feedback from @nehaharidasneo #66(CI).

^{Originally posted by apoorv-neosofttech August 26, 2021}
Support for sending email using sendgrid

^{Originally posted by sasachan August 10, 2021}
Custom item template should help to add new controller

^{Originally posted by sasachan August 5, 2021}

• Global Error Handler Middleware

• custom middleware that catches and handles all exceptions, and determines which HTTP response code to return based on the exception type.

• Custom App Exception

• a custom exception class used to differentiate between handled exceptions that return a 400 response and unhandled exceptions that return a 500 response.

• Startup.cs

• the ASP.NET Core startup class that adds the global error handler middleware to the application request pipeline.
  Example Error Service - an example service that shows how to throw a custom exception that will be handled by the global error handler.

https://jasonwatmore.com/post/2020/10/02/aspnet-core-31-global-error-handler-tutorial

^{Originally posted by apoorv-neosofttech August 25, 2021}
Fluent API integration to define datatype and constraints in EF Core's code first approach

^{Originally posted by sasachan August 13, 2021}
Setup repository folder/source code structure as https://github.com/dotnet-architecture/eShopOnContainers

Specially

• Build
• Deploy
• Src
• Docs
• Others CONTRIBUTING.md.md, README.md, branch-guid.me, github-actions.md
• LICENSE
• .gitattributes
• .gitignore

^{Originally posted by shreedhar-ww August 5, 2021}
Get started with NSwag and ASP.NET Core
https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-5.0&tabs=visual-studio

^{Originally posted by dwivedi-ankita September 1, 2021}
Video Tutorial for following modules,

• VSIX

• Project Setup

• DB-Setup

• Swagger

• Authentication

• Refresh Token

• Logger

• Version-Control

• HealthCheck

• Request-Response

• Email

• CSV download

^{Originally posted by sasachan August 5, 2021}
.NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner

https://github.com/App-vNext/Polly

^{Originally posted by sasachan August 5, 2021}
https://docs.microsoft.com/en-us/learn/modules/integrate-openapi-enabled-web-api-with-apim-and-visual-studio/3-exercise-activate-openapi-to-web-api-using-swashbuckle

Add Swagger and Swagger UI to an ASP.NET Core web API application. The Swagger tooling will assist in creating the OpenAPI document describing your web API