Skip to content

Commit 572a160

Browse files
committed
Add API design checks.
1 parent 137fac2 commit 572a160

2 files changed

Lines changed: 40 additions & 1 deletion

File tree

src/assets/YAML/default/Implementation/DevelopmentAndSourceControl.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,31 @@ Implementation:
4343
isImplemented: false
4444
evidence: ""
4545
comments: ""
46+
API design validation:
47+
risk: Creation of insecure or non-compliant API.
48+
measure: |
49+
Design contract-first APIs using an interface description language such as OpenAPI, AsyncAPI or SOAP
50+
and validate the specification using specific tools.
51+
Checks should be integrated in IDEs and CI/CD pipelines.
52+
difficultyOfImplementation:
53+
knowledge: 2
54+
time: 2
55+
resources: 2
56+
usefulness: 4
57+
level: 2
58+
implementation:
59+
- $ref: src/assets/YAML/default/implementations.yaml#/implementations/stoplight-spectral
60+
- $ref: src/assets/YAML/default/implementations.yaml#/implementations/api-oas-checker
61+
references:
62+
samm2:
63+
- V-ST-1-A
64+
iso27001-2017:
65+
- 8.25 # Secure development lifecycle
66+
- 8.27 # Secure system architecture and engineering principles
67+
- 8.28 # Secure coding
68+
isImplemented: false
69+
evidence: ""
70+
comments: ""
4671
Source Control Protection:
4772
risk: Intentional or accidental alterations in critical branches like master.
4873
measure: >-

src/assets/YAML/default/implementations.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -640,4 +640,18 @@ implementations:
640640
tags: [authentication, authorization, secrets, infrastructure]
641641
url: https://github.com/hashicorp/vault
642642
description: |
643-
A tool for secrets management, encryption as a service, and privileged access management
643+
A tool for secrets management, encryption as a service, and privileged access management.
644+
stoplight-spectral:
645+
name: Spectral
646+
tags: [linting, api, documentation]
647+
url: https://github.com/stoplightio/spectral
648+
description: |
649+
Spectral is a flexible JSON/YAML linter built with extensibility in mind.
650+
It uses JSON/YAML path rules to describe the problems you want to find.
651+
api-oas-checker:
652+
name: API OAS Checker
653+
tags: [linting, api, documentation]
654+
url: https://github.com/italia/api-oas-checker
655+
description: |
656+
A tool to check OpenAPI specifications using a comprehensive ruleset based
657+
on API best practices.

0 commit comments

Comments
 (0)