https://diegogborges.github.io/tags/web-development/Recent content in Web Development on EXPONENTIAL DEV by Diego - Tech BlogHugo -- 0.152.2en-usMon, 17 Nov 2025 00:00:00 +0000https://diegogborges.github.io/posts/rest-api/Mon, 17 Nov 2025 00:00:00 +0000https://diegogborges.github.io/posts/rest-api/<p>Everything you need to know to get started with REST in just a few minutes.</p> <p>REST API is the technology that transformed the way systems communicate with each other. It enables applications, websites, servers, and devices to exchange data quickly, securely, and universally — forming the foundation of modern apps, powerful integrations, and digital experiences that work anywhere.</p> <h2 id="index"><strong>Index</strong></h2> <ul> <li><a href="#-what-is-an-api">What Is an API?</a></li> <li><a href="#-what-is-a-rest-api">What Is a REST API?</a></li> <li><a href="#-key-rest-concepts">Key REST Concepts</a> <ul> <li><a href="#resources">Resources</a></li> <li><a href="#main-http-methods">Main HTTP Methods</a></li> <li><a href="#data-formats">Data Formats</a></li> </ul> </li> <li><a href="#-restful-api-characteristics">🔧 RESTful API Characteristics</a> <ul> <li><a href="#1-stateless">Stateless</a></li> <li><a href="#2-clientserver-architecture">Client–Server Architecture</a></li> <li><a href="#3-cacheability">Cacheability</a></li> <li><a href="#4-uniform-interface">Uniform Interface</a></li> <li><a href="#5-layered-system">Layered System</a></li> </ul> </li> <li><a href="#general-recommendations">General Recommendations</a></li> <li><a href="#use-plural-nouns-in-urls">Use Plural Nouns in URLs</a></li> <li><a href="#keep-the-base-url-simple-and-intuitive">Keep the Base URL Simple and Intuitive</a></li> <li><a href="#avoid-verb-based-urls">Avoid Verb-Based URLs</a></li> <li><a href="#use-http-verbs-to-operate-on-resources">Use HTTP Verbs to Operate on Resources</a></li> <li><a href="#resource-listing-and-detail-retrieval">Resource Listing and Detail Retrieval</a></li> <li><a href="#associations">Associations</a></li> <li><a href="#use-query-parameters-to-reduce-url-complexity">Use Query Parameters to Reduce URL Complexity</a></li> <li><a href="#error-handling">Error Handling</a></li> <li><a href="#versioning">Versioning</a></li> <li><a href="#partial-response">Partial Response</a></li> <li><a href="#pagination">Pagination</a></li> <li><a href="#actions-not-involving-resources">Actions Not Involving Resources</a></li> <li><a href="#multi-format-support">Multi-Format Support</a></li> <li><a href="#attribute-naming">Attribute Naming</a> <ul> <li><a href="#attributes-in-requestresponse-bodies">Attributes in Request/Response Bodies</a></li> <li><a href="#attributes-in-urls-query-parameters">Attributes in URLs (Query Parameters)</a></li> <li><a href="#attributes-in-headers">Attributes in Headers</a></li> </ul> </li> <li><a href="#references">References</a></li> </ul> <hr> <h1 id="what-is-an-api">What Is an API?</h1> <p>An <strong>API (Application Programming Interface)</strong> is a set of standards and protocols that allow different systems or users to interact with an application.<br> It enables clients to access the software’s features and services without needing direct access to its internal implementation.</p>