API van het API register (apis.developer.overheid.nl)
- API version: 1.0.0
- Build date: 2025-04-02
- Generator version: 7.7.0
-
Start de afhankelijkheden:
docker compose up -d
-
Start de server:
go run cmd/main.go
De API luistert standaard op poort 1337.
Nieuwe APIs worden na een succesvolle POST ook naar Typesense gestuurd, zodat ze vindbaar zijn in de zoekfunctie. Stel hiervoor de volgende omgevingsvariabelen in:
TYPESENSE_ENDPOINT: basis-URL van de Typesense cluster (bijv.https://search.don.apps.digilab.network).TYPESENSE_API_KEY: API key met schrijfrechten.TYPESENSE_COLLECTION: naam van de collectie (standaardapi_register).TYPESENSE_DETAIL_BASE_URL: basis-URL voor detailpagina's in de frontend (bijv.https://api-register.don.apps.digilab.network/apis).ENABLE_TYPESENSE: zet opfalseom Typesense indexing volledig uit te schakelen (standaardtrue).
Bij het opstarten van de server wordt automatisch een aparte service gestart die direct een refresh-run uitvoert. Daarna draait de job iedere ochtend om 07:00 en haalt alle geregistreerde APIs opnieuw op. Zodra de OAS is gewijzigd, volgen exact dezelfde stappen als bij een POST: validatie, regeneratie van artifacts (Bruno, Postman en OAS-bestanden) en het opruimen van verouderde bestanden. Er zijn geen extra omgevingsvariabelen nodig.
Voor user-facing wijzigingen (fix/feature/breaking) verwachten we per PR een Changie-fragment in .changes/unreleased.
Eenmalig installeren:
go install github.com/miniscruff/changie@latestFragment aanmaken:
changie newNormaal is een fragment niet nodig voor interne refactors zonder zichtbaar effect, docs-only wijzigingen en CI-only tweaks.
Bij een release kun je de fragments bundelen in CHANGELOG.md:
changie batch <version>Dit gebeurt ook automatisch bij elke merge naar main via GitHub Actions:
changie batch auto en daarna changie merge, waarna automatisch een PR met de changelog-updates wordt aangemaakt.