Skip to content

api-evangelist/restful

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RESTful

Representational State Transfer (REST) is an architectural style for designing networked applications defined by Roy Fielding in his 2000 doctoral dissertation. RESTful systems use stateless HTTP communication and a uniform interface to enable scalable, loosely coupled web services. This index covers the REST architectural style, maturity models, hypermedia formats, and key specifications.

References

Type URL
Roy Fielding Dissertation https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm
Richardson Maturity Model https://martinfowler.com/articles/richardsonMaturityModel.html
OpenAPI Specification https://spec.openapis.org/oas/latest.html
RFC 9110 HTTP Semantics https://datatracker.ietf.org/doc/html/rfc9110
IANA HTTP Status Codes https://www.iana.org/assignments/http-status-codes/

Notable Specifications and Patterns

Name Description URL
Richardson Maturity Model REST maturity levels 0-3 https://martinfowler.com/articles/richardsonMaturityModel.html
JSON:API Standardized JSON API format https://jsonapi.org/
HAL Hypertext Application Language https://stateless.co/hal_specification.html
OpenAPI Specification REST API description standard https://spec.openapis.org/oas/latest.html
RFC 9110 HTTP Semantics HTTP methods, status codes, headers https://datatracker.ietf.org/doc/html/rfc9110

Artifacts

JSON Schemas

File Description
json-schema/restful-api-description-schema.json Schema for describing a RESTful API

JSON Structures

File Description
json-structure/restful-api-description-structure.json RESTful API description field reference

JSON-LD Context

File Description
json-ld/restful-context.jsonld JSON-LD context for REST architectural concepts

Vocabulary

File Description
vocabulary/restful-vocabulary.yml REST constraints, maturity model, hypermedia, and design principles

Maintainers

About

Representational State Transfer (REST) is an architectural style for designing networked applications, using stateless communication and standard HTTP methods for web services. Modern development teams rely on it to improve code quality, collaboration, and delivery speed.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors