from nikolasdimi@lemmy.world to selfhosted@lemmy.world on 18 Jun 19:02
https://lemmy.world/post/48335221
Wanted to provide an update around the CLI runner that we shipped a few days ago. This was already on beta for quite some time so now that its on stable, I thought of giving it another go in the community.
For those who are not familiar with the tool and what the h#$@ I am talking about: Voiden is an offline, git-native API tool built on Markdown.
We built it (and then open sourced it) because API tooling sucked (and we work a lot of APIs enough to care to do something about it). I will just name a few issues: cloud dependencies, forced accounts, proprietary formats plus many more.
Long story short, this is Voiden: instead of keeping API requests inside a cloud workspace, Voiden stores them as .void files that can live with your codebase, be versioned in Git, reviewed in PRs, and reused across a team. Plus everything is plain executable markdown. By “everything” I mean really everything: API specs, tests, docs, context…everything.
We have now released the @voiden/runner, which is a headless CLI for running those .void files outside the desktop app.
The runner executes the requests, prints the results, and exits with a standard exit code that CI systems can use.
Things to note:
- runs on Node.js 18+
- works in terminal, CI/CD, Docker, and cron jobs
- supports REST, WebSocket, gRPC, and GraphQL
- supports request chaining through runtime variables
- works with core Voiden plugins like scripting, assertions, faker, advanced auth, + more.
The ultimate goal is to make .void files executable API workflows, not just files used inside the desktop app.
The Github repo: github.com/VoidenHQ/voiden
Voiden CLI Runner : github.com/VoidenHQ/voiden/tree/…/voiden-runner
Visit Voiden here : voiden.md
P.S this post is mainly around the Runner but every feedback outside that is also welcome, especially coming from any postman or insomnia power users in the room :)
threaded - newest
Why the name “voiden”? Making things void is the opposite of what I want to do with apis.
haha the idea comes from the fact that the tool is not opinionated - in the sense that yes its an API client but its also an editor, etc. So it a tool with infinite possibilities and can be as flexible as people want. So this is the idea: void-endlessness-freedom.
If it didn’t scare you alot, will you try it? :)
I don’t have a use case right now, else I would.
If English isn’t your first language, “void” has a connotation of emptiness, nothingness. APIs are about constructing, not emptying.
I feel the void whenever I need to script APIs, it’s fine.
If you POST into the void long enough, one day, the void POSTs back.
haha