README.md

ApiNET

This project contain web api use-case samples to build restful services for any applications

Technical Specifications

• Validation - FluentValidation for model validation
• Data Access Framework - ORM - EntityFrameworkCore - Generic Repository
• MediaTypeFormatter - WebAPIContrib.Core
• Json PATCH - Microsoft.AspNetCore.JsonPatch
• Database - Local SQL Server
• Project Details
  • See Data Model by class diagram
  • See Project Structure

Use-Cases

• Simple CRUD Operations 🆗
  • GET, POST, DELETE, PUT, HEAD, PATCH
• Bulk Operations 🆗
• Filtering, searching and paging Operations 🆗
• Consume External API 🆗
  • HttpClient
  • ApiService
• Request/Response Loging 🆗
• Model Validations 🆗
• Versioning 🆗
• XML/JSON Output 🆗
• MediaType Formatters
  • Plain-Text 🆗
  • CSV 🆗
  • BSON 🆗 - Binary JSON
• Transactional Web Api
• Api Licesing 🤔

OData Services with Web Api

• OData (Open Data Protocol) 🆗
• Microsoft.AspNetCore.OData
• About Standarts
  • https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata
  • https://www.odata.org/
• Links
  • https://docs.microsoft.com/en-gb/odata/
  • https://devblogs.microsoft.com/odata/

Concepts

• Microservices 🚩
• API Gateway 🚩

Performance

• Caching 🆗
  • Memory Cache
  • Http Cache-Control
• Asynchronous Web Api 🆗
• Content Compression (GZIP or Deflate)
• Faster Data Access 🤔
  • Consider alternatives ; ADO.NET, Dapper, Nosql Databases

Security

• Thottling Web API
  • Tiers of Throttling
    • API-level throttling
    • Application-level throttling
    • User-level throttling
    • Account-level throttling
  • Rate-Limit Throttling
  • IP-level Throttling 🆗
    • WhiteListing - Allow traffic only to known addresses
    • BlackListing - Deny traffic to known addresses
  • Scope Limit Throttling
  • Concurrent Connections Limit
  • Resource-level Throttling
• Authentication - JWT 🆗
• Authorization

Testing

• Unit Test
• Load Test
  • https://websurge.west-wind.com/
• Scheduled Api Tester
  • https://uptimerobot.com/
• Health Check Page
• Status Page for API and System
  • https://api.twitterstat.us/
  • https://reddit.statuspage.io/
  • https://status.dropbox.com/
  • https://status.digitalocean.com/

Documentation

• Swagger 🆗
• Postman 🆗
  • ApiNET Services
• API Portal 🎉
  • https://developer.isbank.com.tr/
  • https://developer.turkishairlines.com/
  • https://apiportal.akbank.com/
  • https://apiportal.yapikredi.com.tr/
  • https://developers.garantibbva.com.tr/

Tools

• SoapUI
• Postman
• Fiddler
• Swagger

Code Quality-Refactoring

• API Analyzer
• CodeMaid

Useful Links

• https://www.restapitutorial.com
• https://restfulapi.net/

Contribution

Pull requests are welcome, but make sure you sign the Contributor License Agreement.

License

ApiNET is licensed under the MIT license. Check the LICENSE file for details.