Web API is a popular tool used for current middle-tier development. Web API is based on the concept of REST. These two articles are summaries of REST and REST-related issues with my understanding.

The second article was my learning notes several years ago, summarising the REST features, related issues and my understanding. When I tried to rewrite them into an article, I found out that I should review and briefly summarize the basic concept of REST, but that is not just easy work and can be done in several words or sentences. Then I think I'd better write another article for the basic concept of REST, that is REST(1), In Concept.

The third article was a presentation in a REST Web API forum, In that I used some materials coming from the first two articles, but I discussed them in a different angle.

The fourth article, this one, will discuss REST Web API Naming Convetion.

Introduction

This will be the contents of this article,

  • What is REST
  • Why is REST Web API, Why not
  • REST Based Service vs. RESTful Service

A: What is REST

From Internal Wiki:

 

 

From Outside:

 

camelCase

Id

 

Plural

RestApi Resource URIs --- Kim,, REST Resource Naming Guide (restfulapi.net)

 

Verbs

RESTful API Design: nouns are good, verbs are bad | Google Cloud Blog

REST API Best Practices – REST Endpoint Design Examples (freecodecamp.org)

Rest URL and Resource Naming Best Practices - Restful API

Web API design best practices - Azure Architecture Center | Microsoft Docs

REST API Architectural Constraints - GeeksforGeeks

C# Coding Conventions | Microsoft Docs

 

Before Change:

 

 

Old

New

 

Old

 

New

08/05

 

 

 

 

 

 

C:\Users\gghan\source\repos\Work\JCG\ASP.NETWebAPI

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Summary

This article is understanding the concept of REST and RESTful Service in practice.

 

Reference