René's URL Explorer Experiment

Title: Web API Design Best Practices - Azure Architecture Center | Microsoft Learn

Open Graph Title: Web API Design Best Practices - Azure Architecture Center

Description: Learn how to apply best practices for designing RESTful web APIs that support platform independence and loose coupling for service evolution.

Open Graph Description: Learn how to apply best practices for designing RESTful web APIs that support platform independence and loose coupling for service evolution.

Keywords:

API standards

Opengraph URL: https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design

X: @MicrosoftLearn

direct link

Domain: docs.microsoft.com

color-scheme	light dark
twitter:card	summary_large_image
og:type	website
og:image:alt	Microsoft Learn
og:image	https://learn.microsoft.com/en-us/media/open-graph-image.png
platform_id	aeae6090-1f11-ab77-9cde-894c31746737
scope	Azure,Azure Architecture Center
locale	en-us
uhfHeaderId	azure
page_type	conceptual
feedback_system	Standard
breadcrumb_path	/azure/architecture/bread/toc.json
ms.author	pnp
ms.service	azure-architecture-center
ms.update-cycle	1095-days
manager	coxford
ms.topic	best-practice
author	claytonsiemens77
ms.date	2025-03-27T00:00:00Z
ms.subservice	best-practice
document_id	ad651d6a-f8d8-2050-e7a7-adbae7326112
document_version_independent_id	4fddd724-cabd-8623-7692-857088c1dccb
updated_at	2026-06-03T05:05:00Z
original_content_git_url	https://github.com/MicrosoftDocs/architecture-center-pr/blob/live/docs/best-practices/api-design.md
gitcommit	https://github.com/MicrosoftDocs/architecture-center-pr/blob/069a83fe2cc8d78c25f4123a93ba3b9819821147/docs/best-practices/api-design.md
git_commit_id	069a83fe2cc8d78c25f4123a93ba3b9819821147
site_name	Docs
depot_name	MSDN.azure-architecture-center-pr2
schema	Conceptual
toc_rel	../toc.json
pdf_url_template	https://learn.microsoft.com/pdfstore/en-us/MSDN.azure-architecture-center-pr2/{branchName}{pdfName}
word_count	6682
asset_id	best-practices/api-design
item_type	Content
source_path	docs/best-practices/api-design.md
previous_tlsh_hash	1B5F0603B80C4B10FF831E551867F99014F0804D9BB0AB8415263772F5DA3EB34B196AF6F3D363C4233642A70292AA4FA3D5E739D17C73B22569E8AD819C3592A7E937BBC4
github_feedback_content_git_url	https://github.com/microsoftdocs/architecture-center/blob/main/docs/best-practices/api-design.md
markdown_url	https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design?accept=text/markdown
cmProducts	https://authoring-docs-microsoft.poolparty.biz/devrel/540ac133-a371-4dbb-8f94-28d6cc77a70b
spProducts	https://authoring-docs-microsoft.poolparty.biz/devrel/60bfc045-f127-4841-9d00-ea35495a5800

Links:

Skip to main content	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#main
Skip to Ask Learn chat experience	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design
Download Microsoft Edge	https://go.microsoft.com/fwlink/p/?LinkID=2092881
More info about Internet Explorer and Microsoft Edge	https://learn.microsoft.com/en-us/lifecycle/faq/internet-explorer-microsoft-edge
Read in English	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design
Edit	https://github.com/microsoftdocs/architecture-center/blob/main/docs/best-practices/api-design.md
signing in	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design
Data partitioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/data-partitioning
Use Hypertext as the Engine of Application State (HATEOAS) to enable navigation to related resources	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#implement-hateoas
Chatty I/O	https://docs.microsoft.com/en-us/azure/architecture/antipatterns/chatty-io/
Extraneous Fetching	https://docs.microsoft.com/en-us/azure/architecture/antipatterns/extraneous-fetching/
GET	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#get-requests
POST	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#post-requests
PUT	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#put-request
PATCH	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#patch-requests
DELETE	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#delete-requests
RFC 5789	https://tools.ietf.org/html/rfc5789
RFC 7396	https://tools.ietf.org/html/rfc7396
RFC 6902	https://tools.ietf.org/html/rfc6902
Provide asynchronous support for long-running requests	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-implementation#provide-asynchronous-support-for-long-running-requests
Asynchronous Request-Reply pattern	https://docs.microsoft.com/en-us/azure/architecture/patterns/asynchronous-request-reply
URI versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#uri-versioning
Query string versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#query-string-versioning
Header versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#header-versioning
Media type versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#media-type-versioning
URI versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#uri-versioning
query string versioning	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#query-string-versioning
Map requests to tenants in a multitenant solution	https://docs.microsoft.com/en-us/azure/architecture/guide/multitenant/considerations/map-requests
tenant-specific domains	https://docs.microsoft.com/en-us/azure/architecture/guide/multitenant/considerations/domain-names
Preserve the hostname	https://docs.microsoft.com/en-us/azure/architecture/best-practices/host-name-preservation
the complexity of modern architectures increases	https://docs.microsoft.com/en-us/azure/architecture/best-practices/monitoring
HATEOAS	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design#implement-hateoas
OpenAPI Initiative	https://www.openapis.org
ASP.NET Core web API documentation with Swagger/OpenAPI	https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger
recommendations for designing REST APIs on Azure	https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md
checklist	https://mathieu.fenniak.net/the-api-checklist
software as a service and multitenant solution architectures	https://docs.microsoft.com/en-us/azure/architecture/guide/saas-multitenant-solution-architecture/
en-us	https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design
Your Privacy Choices	https://aka.ms/yourcaliforniaprivacychoices
AI Disclaimer	https://learn.microsoft.com/en-us/principles-for-ai-generated-content
Previous Versions	https://learn.microsoft.com/en-us/previous-versions/
Blog	https://techcommunity.microsoft.com/t5/microsoft-learn-blog/bg-p/MicrosoftLearnBlog
Contribute	https://learn.microsoft.com/en-us/contribute
Privacy	https://go.microsoft.com/fwlink/?LinkId=521839
Consumer Health Privacy	https://go.microsoft.com/fwlink/?linkid=2259814
Terms of Use	https://learn.microsoft.com/en-us/legal/termsofuse
Trademarks	https://www.microsoft.com/legal/intellectualproperty/Trademarks/

Viewport: width=device-width, initial-scale=1.0

URLs of crawlers that visited me.