don-apis
Scannednpx machina-cli add skill dstotijn/developer-overheid-nl-agent-skills/don-apis --openclawDON APIs
When to Use This Skill
Use this skill when you need guidance on:
- API
- REST
- OpenAPI
- OAS
- webhooks
How to Navigate
This skill contains documentation organized by topic. Browse the references below or ask about specific topics.
References
Aan De Slag
Api Design Rules
- api-design-rules-linter
- api-design-rules-validator
- cheat-sheet
- doc-openapi-contact
- doc-openapi
- http-methods
- index
- no-trailing-slash
- publish-openapi
- semver
- uri-version
- version-header
- index
Architectuur
Gedrag En Implementatie
- gelijktijdigheid-met-optimistic-locking
- API Gedrag en Implementatie
- problem-details
- retries-met-volledige-idempotency
Openapi Specification
Tools
Source: https://github.com/developer-overheid-nl/don-site/tree/main/docs/apis
Source
git clone https://github.com/dstotijn/developer-overheid-nl-agent-skills/blob/main/skills/don-apis/SKILL.mdView on GitHub Overview
DON APIs provides Dutch government API design rules, OpenAPI specifications, and architecture guidance. It helps teams build compliant, interoperable REST APIs and adopt patterns like webhooks and event-driven architectures.
How This Skill Works
The skill is organized around topic-based references (API design, OpenAPI, architecture) and links to concrete tooling such as a linter, validator, and cheat-sheet. It directs you to hands-on references like Bouw een API and Maak een OpenAPI (OAS) to implement patterns such as webhooks and event-driven architecture.
When to Use It
- Building a REST API for Dutch government projects and needing governance rules.
- Creating or validating an OpenAPI (OAS) specification for a service.
- Implementing API design patterns like webhooks or event-driven architecture.
- Applying the API design rules linter or validator to enforce standards.
- Aligning API architecture with cloud events and other governance references.
Quick Start
- Step 1: Browse the references under Aan De Slag (Bouw een API and Maak een OAS).
- Step 2: Run the api-design-rules-linter or api-design-rules-validator to check your design.
- Step 3: Create or update your OpenAPI spec (Maak een OAS) and review against the cheat-sheet.
Best Practices
- Use the OpenAPI spec as the single source of truth for your API contract.
- Leverage the linter/validator and cheatsheet to catch design violations early.
- Follow consistent HTTP methods, clear versioning, and standardized error handling.
- Prefer explicit webhooks and event-driven patterns where appropriate.
- Keep references and examples up to date with the DON API guidance.
Example Use Cases
- Design and publish a government data API following the DON rules.
- Generate an OpenAPI spec for a public service endpoint (Maak een OpenAPI).
- Validate an API design with the api-design-rules-linter and fix violations.
- Implement a webhook-driven notification API in compliance with the rules.
- Adopt cloud events for cross-system messaging in an EDA setup (cloudevents).
