https://github.com/belgif/rest-security
The Belgif REST Security Guide is ought to be regarded as an addendum to the Belgif REST Guidelines.
https://github.com/belgif/rest-security
belgif belgium guide rest rest-api restful-api security
Last synced: 2 months ago
JSON representation
The Belgif REST Security Guide is ought to be regarded as an addendum to the Belgif REST Guidelines.
- Host: GitHub
- URL: https://github.com/belgif/rest-security
- Owner: belgif
- License: apache-2.0
- Created: 2021-07-08T13:35:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-10-19T23:04:47.000Z (8 months ago)
- Last Synced: 2025-10-20T05:01:15.260Z (8 months ago)
- Topics: belgif, belgium, guide, rest, rest-api, restful-api, security
- Language: CSS
- Homepage:
- Size: 378 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# REST Security Guide
## Overview
The REST Security Guide, built from these sources, will be available on https://www.belgif.be/specification/rest/security-guide/.
This guide is the result of a collaboration between several Belgian public institution and intends to raise awareness of security best practices for those involved in the development and maintenance of RESTful services.
See the [wiki](https://github.com/belgif/rest-security/wiki) for more information on the organization of the REST Security workgroup and its meeting reports.
## Guidelines for repository contributors
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the REST Security guide are to be interpreted as described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119).
Rules must follow the following format:
```
[.rule, caption="Rule {counter:rule-number}: "]
.rule title
====
====
```
Examples must follow the following format:
```
.example title
====
====
```
## Building the guide
The guide is built with [Apache Maven](https://maven.apache.org).
With Maven installed, run `mvn site` in the root directory of the project.
The guide will be built in the `target/site/doc/` directory.