REST Guidelines

Introduction

This guide is a living document, updated when new interoperability issues arise or when REST-related standards evolve.

REST is the defacto standard to communicate with web services from JavaScript and native mobile applications.
REST has become the industry standard for developing APIs on the web (Google, Facebook, Amazon, Twitter, etc).

Topics not covered in this guide:

Securing REST APIs. Guidelines are under development by the REST Security Working Group, based on the OpenID Connect and OAuth 2.0 standards.
OpenAPI specifications for common data types can be found in the openapi-* GitHub repositories.

This guide is based on the REST guild published by the Belgian Interoperability Framework.
Original Sources: https://github.com/belgif/rest-guide

Note

For brevity most URIs in examples are shortened, but in practice URIs should be in absolute notation.

License

This work is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.