Your REST time is so precious!

Forum to post a question, propose new feature or a tip for other users

Code@Anasoft Forum

YouTube how todo

Watch our YouTube channel with instructions

Instructions

1. Download and install full featured extension (VSIX).
2. Open Visual Studio and select new RestApiNE(x)/ApiNCoreE(x) (with ER ORM) solution template from Visual C# templates section.
3. After the solution is built and depencies automatically resolved - update DB connection in API and Test project (appseting.json file)
4. Run API project to start up REST API service and that initiates db migration and display the service the info page.
5. The service info/startup page has information about REST API service and the link to Swagger documentation/test page.
6. Run all unit tests in Test project.
7. The third way to test generated REST API service is either to import generated Postman json tests file to Postman UI or run PowerShell/Newman script to execute tests and generate/email html report tests results.
8. Set REST API and Blazor test project as start up and run the solution

Extending the service (T4 code generation/scaffolding) with added entity classes:

9. Create new entity classes (must inherit from BaseEntity) in Entity project, Entity folder.
10. To execute all T4 templates right-click on CodeGeneratorUtility.bat file(Entity project) and OpenWith command using PowerShell (may need to -Add...- PowerShell program).
IMPORTANT NOTE:Make sure when running T4 no other VS instances are open to avoid any reference conflict.
IMPORTANT NOTE:Make sure when running T4 that in VS PackageManagerConsole Your.Entity project is setup as default one in order to support DB migration.
11. For added entity clases all supporting code (domain, services, API, Tests, db migration code) will be generated and new Postman json file with added tests.
12. Run API project to start up REST API and get info page. The same time db migration will be executed/deployed to the database.
13. Run all unit tests in Test project.
14. Run PowerShell/Newman script in Test/Postman to execute tests and generate/email html report tests results.
15. Go for a sleep, run, walk or...

.

---

Download full version of REST API VSIX

Code First or Database First

This extension is primary designed for "code first" approach however it can be used to build REST API code from existing database with some database modifications. These are basic steps required to connect RestApiNEx solution to existing database:

Create RestApiNEx with solution name the same as existing database name

Start created solution (so start up tables Account and User get created in the database)

Two options from here:

a) Manually create new entities (must subclasss BaseEntity) to match existing tables (step 2) and update existing table(s) structure with adding RestApi system columns (in yellow) or jusd recreate all tables with migration script

b) Use EF scafolding db script to scaffold enitities from existing tables (note that for more complex db structures it may not work for all tables so this argument can be used -Tables Table1,Table2)
Scaffold-DbContext "Server=.\SQLExpress;Database=YourSolutionDBName;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Entity -DataAnnotations -NoPluralize

All generated entities to be updated with subclasss BaseEntity; confirm code created in new db context

Run T4 scripts to generate REST API code (step 3)

Run new tests (step 4)

Swagger API tests

Note that Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge.(not IE)
Set and save in configuration file (appsettings.json) in API project this setting to use JWT authentication:
"Authentication":"UseIndentityServer4": false,

Run API service and click Swagger API specification button.

Find Token service (JWT), use Try it out button and enter these values (exists in test project code and match values in User table)):
{
"username": "my@email.com",
"password": "mysecretpassword123"
}

Execute Token service and copy returned token value: eyJhbGc...

Click Authorize button on the top of the Swagger page and add value Bearer eyJhbGc.... Click Authorize button.

All service calls are now authorized and can be tested.

Automate Postman tests with Newman

Postman tests with Newman :

Generated solution contains adjusted Postman tests as json file (in Test project) ready for import and run in Postman application.

The same folder has PowerShell script and instructions how to execute Postman tests json from command line using Newman (Node.js required) a command line collection runner. With the script generated htlm tests reports can be opened or emailed.

DDoS attacks protection

A Distributed Denial of Service attacks (or DDoS) overloads a network system, saturating the target machine with requests either slowing down traffic or blocking it completely. Firewalls have no intelligence on what business transaction is being performed so not always the best choice for DDoS attacks protection.
Rest API solution generated by RestApiNEx Visual Studio extension provides optional DDoS atacks protection services with added a middleware extension for DDoS protection service.
This is configuration settings for REST API DDoS attacks protection:
"DDosAttackProtection": {
"Enabled": true,
"FullServiceLevelProtection": true,
"MaxHitsPerOrigin": 100,
"MaxHitsPerOriginIntervalMs": 1000,
"ReleaseIntervalMs": 3600000
}
It means that all REST API calls are protected (FullServiceLevelProtection: true) and if 100+ request comes in 1 seconds from the same IP, the IP will be blacklisted and the response only set as HttpStatusCode.Forbidden. After one hour (3600 secs) blacklisted IP will be set as whitelisted.
For selected REST API calls protection set FullServiceLevelProtection: false and flag selected REST API call/controller-method with this attribute [DDosAttackProtected] .
Integration test is provided for DDoS attacks protection but Postman tests can used for testing DDoS attacks protection service with FullServiceLevelProtection: true settings and using multiple tests iterations.

Docker

Visual Studio Dockerfile and docker-compose added for for developing RestApiNEx solution with Docker images/containers for REST API services, BlazorTestWeb app and MS SQL database.
Docker desktop must be installed.
After initial solution created these steps are required before run docker-compose build/execute:

Close created solution

Run PowerShell script fixDockerConfiguration.ps1 located in *.Api solution project folder (this is workaround for Docker/VS issue locating VS solution files)

Run Docker desktop

Install required images

Open the solution

Set startup project as docker-compose and run the solution
Note that the first run may take more time to download .net core and sql db image as base images.

Publish to cloud computing platforms

(NOTE: This is just information - no support by Code@Anasoft team would be provided on publishing to any cloud platform at this moment.
Future versions of this extension may contain automated deployment to could platform and than such support would be avaliable)

Get full-featured VSIX extensions for Visual Studio

(with T4 code generation for extending a solution; XUnit project integration tests; Postman/Newman tests, DDoS protection service, Blazor client)

Get the whole package including:

RestApiNEx(versions .NET 8, 7, 6 and 5), RestApiNLx(versions .NET 8, 7, 6 and 5) and ApiNCoreEx (.NET Core 3.1/2.2) vxsix extensions with EF ORM and T4s ,

RestApiNDx (.NET 8.x), RestApiNDx (.NET 6.x), RestApiNDx (.NET 5) and ApiNCoreDx (.NET Core 3.1/2.2) vxsix extensions with Dapper ORM, FluentMigrator, Postman, Swagger, DDoS attacks protection and T4s

RestApiPyEx - Python REST API vsix extension (+wrapper) with flask,json,pyodbc,flasgger,swagger and db migration

BONUS: Google Drive JQuery plugin demo solution (quickly connect and use GDrive storage from JavaScript)

Get all extensions for only $55 CAD and save many hours to start with fully functional .NET Core REST API.

NOTE: Please use Paypal "Return to merchant" link after your payment in order to get VSIXs download page.