https://github.com/thearchitector/openendpoint-tools
It's like Hamburger Helper, but DevOps REST endpoints for projects instead.
https://github.com/thearchitector/openendpoint-tools
api devops game open-endpoints peer-to-peer pong prototype rollup vlang vweb webrtc
Last synced: about 1 month ago
JSON representation
It's like Hamburger Helper, but DevOps REST endpoints for projects instead.
- Host: GitHub
- URL: https://github.com/thearchitector/openendpoint-tools
- Owner: thearchitector
- License: mit
- Created: 2023-03-06T03:46:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-19T06:23:31.000Z (over 3 years ago)
- Last Synced: 2025-03-03T10:15:20.673Z (over 1 year ago)
- Topics: api, devops, game, open-endpoints, peer-to-peer, pong, prototype, rollup, vlang, vweb, webrtc
- Language: JavaScript
- Homepage: https://openendpoint.tools/ping/
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openendpoint-tools
It's like Hamburger Helper, but DevOps REST endpoints for projects instead.
A set of arguably useful endpoints for various management, testing, and distribution purposes.
## Endpoints
- [/ping/](polypong/README.md)
A better (by some metrics) healthcheck endpoint.
- [/metrics/generic](api/src/metrics.v)
Sending a `POST` request to this endpoint will store the given number alongside the provided slug. Slugs must be alphanumeric. After creation, you must supply the `authkey` in order to update it.
```json
{
"slug": "",
"metric": 47,
"percentage": false,
"authkey": ""
}
```
Sending a `GET` request to this endpoint will return a JSON object matching the [Shield.io custom endpoint schema](https://shields.io/endpoint).
```sh
$ curl /metrics/generic/YOUR_SLUG
{
"schemaVersion": 1,
"label": "metric",
"message": "47",
}
```
## Development
This project is an experiment / prototype application running on the V language and builtin application server `vweb`. Structurally, each endpoint group is a file that contains both the routes and controlling functions for said group.
There is no builtin way to test vweb server endpoints, so the tests are written as `curl` commands in the `./api/scripts/tests.sh` script. To test:
```sh
$ docker compose down --volumes
$ docker compose run --rm api ./scripts/tests.sh
```
## License
Copyright (c) 2023 Elias Gabriel
This tool and its source code are licensed under MIT. See the license [here](./LICENSE).