Edition 0 Updated to asp. Net core 0



Yüklə 11,82 Mb.
Pdf görüntüsü
səhifə100/288
tarix12.07.2023
ölçüsü11,82 Mb.
#136458
1   ...   96   97   98   99   100   101   102   103   ...   288
public
class
CatalogController : ControllerBase 

// Implementation ...
This versioning mechanism is simple and depends on the server routing the request to the 
appropriate endpoint. However, for a more sophisticated versioning and the best method when using 
REST, you should use hypermedia and implement 
HATEOAS (Hypertext as the Engine of Application 
State)

Additional resources 

ASP.NET API Versioning
 
https://github.com/dotnet/aspnet-api-versioning
 

Scott Hanselman. ASP.NET Core RESTful Web API versioning made easy
https://www.hanselman.com/blog/ASPNETCoreRESTfulWebAPIVersioningMadeEasy.aspx
 

Versioning a RESTful web API
https://learn.microsoft.com/azure/architecture/best-practices/api-design#versioning-a-restful-
web-api
 

Roy Fielding. Versioning, Hypermedia, and REST
https://www.infoq.com/articles/roy-fielding-on-versioning
 
Generating Swagger description metadata from your ASP.NET Core 
Web API 
Swagger
 is a commonly used open source framework backed by a large ecosystem of tools that helps 
you design, build, document, and consume your RESTful APIs. It is becoming the standard for the APIs 
description metadata domain. You should include Swagger description metadata with any kind of 
microservice, either data-driven microservices or more advanced domain-driven microservices (as 
explained in the following section). 
The heart of Swagger is the Swagger specification, which is API description metadata in a JSON or 
YAML file. The specification creates the RESTful contract for your API, detailing all its resources and 
operations in both a human- and machine-readable format for easy development, discovery, and 
integration. 
The specification is the basis of the OpenAPI Specification (OAS) and is developed in an open, 
transparent, and collaborative community to standardize the way RESTful interfaces are defined. 


112 
CHAPTER 5 | Designing and Developing Multi-Container and Microservice-Based .NET Applications 
The specification defines the structure for how a service can be discovered and how its capabilities 
understood. For more information, including a web editor and examples of Swagger specifications 
from companies like Spotify, Uber, Slack, and Microsoft, see the Swagger site (
https://swagger.io
). 

Yüklə 11,82 Mb.

Dostları ilə paylaş:
1   ...   96   97   98   99   100   101   102   103   ...   288




Verilənlər bazası müəlliflik hüququ ilə müdafiə olunur ©azkurs.org 2024
rəhbərliyinə müraciət

gir | qeydiyyatdan keç
    Ana səhifə


yükləyin