Web API Scaffolding

 Key points

What is API ?
What is Scaffolding ?
How to do it ?
Best Practices of API


What is api ?

Application Programming Interface

  • An API is a set of definitions and protocols for building and integrating application software.
  • APIs let your product or service communicate with other products and services without having to know how they’re implemented. This can simplify app development, saving time and money.



What is Scaffolding ?

Scaffolding is a code generation framework

Scaffolding, as used in computing, refers to one of two techniques: The first is a code generation technique related to database access in some model–view–controller frameworks; the second is a project generation technique supported by various tools.

There are two options for scaffolding MVC; Minimal and Full. If you select Minimal, only the NuGet packages and references for ASP.NET MVC are added to your project. If you select the Full option, the Minimal dependencies are added, as well as the required content files for an MVC project. To easily use scaffolding, select Full dependencies.


How to do it?

  • Scaffolding By Database via Entity Framework
  • Scaffolding by open api specification document like swagger Or  other client-side tool like postman


How to do it ?

  1. Create Database or use old created database
  2. Create .NET Core Project – Choose API template while creating project
  3. Install NuGet packages like Entity Framework Core, Entity Framework Core Tools, Entity Framework Core Design, Entity Framework Core SQL, Entity Framework Core SQL Design
  4. Open Package Manage Console and execute command: Scaffold-DbContext "Server=.;Database=SchoolDB;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models
  5. Go to controller folder and add new scaffolded item or Controller. 
  6. Choose API controller with Actions using Entity Framework
  7. Choose Model, Context and DB and Add
  8. Write your business code










Best practices of api

What to consider: Documentation, Stability and Consistency, Flexibility, Security

  1. Ease of Adoption
  2. Use JSON
  3. Use Nouns instead of Verbs -  like - GET /books/123, DELETE /books/123, POST /books, PUT /books/123,  PATCH /books/123
  4.  Name the collections using Plural Nouns
  5. Use resource nesting to show relations or hierarchy
  6.  Error Handling
  7.  Filtering, sorting, paging, and field selection like Filtering: GET /users?country=USA, GET /users?creation_date=2019-11-11, GET /users?creation_date=2019-11-11
  8. Sorting: GET /users?sort=birthdate_date:asc, GET /users?sort=birthdate_date:desc
  9. Paging: GET /users?limit=100, GET /users?offset=2
  10. Versioning https://us6.api.mailchimp.com/3.0/ (major + minor version indication)  https://api.stripe.com/v1/ (major version indication only)   https://developer.github.com/v3/  (major version indication only)   https://api.twilio.com/2010-04-01/ (date based indication)
  11. API Documentation
  12. Using SSL/TLS


Comments

Post a Comment

Popular posts from this blog

Using C#9 record and init property in your .NET Framework 4.x, .NET Standard and .NET Core projects

Image
C#9 record and C#9 init property are really nice addition to the language. As explained in C#9 records:  immutable classes, both are syntactic sugar that don’t require any change at IL level nor runtime levels. It is then legit to want to use them in your projects targeting: .NET Framework version 4.0 or upper .NET Core version 2.0 or upper .NET Standard version 2.0 or upper However you cannot use these syntaxes as-is. By default C#9 is not supported on a .NET Fx 4.x projects: C#9 not supported by default on .NET Framework projects To use record and init in your  not yet migrated to .NET 5.0  projects  two steps are required . Step 1: Set LangVersion to 9.0 in your .csproj Manually set  <LangVersion>9.0</LangVersion>  in your  .csproj . To do so, in Visual Studio, first unload the project and second edit it. For .NET Core and .NET Standard projects you can just edit the project. There is no need to unload it first. Set C# LangVersion 9 in y...
Read more

Where you can locate files in Telligent Community DB Server Site?

Where you can locate files in Telligent Community DB Server Site? There are two file storage folders where you can find all files which is posted in Forums, Posts or in Replies of any discussion. Root of Web Site  -->  Web\filestorage\telligent.evolution.components.attachments Root of Web Site --> Web\filestorage\CommunityServer.Components.PostAttachments You can find any upload in Root of Web Site  --> Web\filestorage\CommunityServer.Components.MultipleUploadFileManager You can find Bread Crumb from below formula Home >> Group Name >> Forum Name >> Thread Name or Home >> Group Name >> Parent Group Name >> Section Name >> Post Name You can find below script to export CSV with all posts and links to file storage clear $ClientCSVPath = "C:\Users\$env:UserName\Documents\WikiPostSectionFiles.csv" $SqlConnection = New-Object System.Data.SqlClient.SqlConnection $SqlConnection.ConnectionString = "Dat...
Read more

Easy Steps to migrate from Telligent CS to SP Online

Telligent Community is a community platform that provides an integrated suite of modern community applications such as forums, blogs, wikis, media galleries, and calendars with a fully customised user experience and Restful platform APIs SharePoint Online is a cloud-based service that helps organisations share and collaborate with colleagues, partners, and customers. With SharePoint, you can access internal sites, documents, and other information from anywhere How to migrate from Telligent Community Site to SharePoint Online Site in to three easy steps? 1) Map Wiki Pages, Forums, Threads, PostsAttachment to FileStorage sub-folders. 2) Export Wiki Pages, Forums, Threads, Posts related to Discussion and its attachment(link of Files) in to CSV files by using Power shell script From Telligent Community Site. 3) Import Wiki Pages into Site Pages, (Categories, Editors, Tags, Ratings) into List, Post Attachments like PDF, image, docs into Libraries In to SharePoint Online. 1)...
Read more