https://github.com/hstreamdb/http-services
https://github.com/hstreamdb/http-services
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hstreamdb/http-services
- Owner: hstreamdb
- Created: 2022-03-11T06:35:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T05:04:26.000Z (over 3 years ago)
- Last Synced: 2025-03-15T00:51:13.585Z (over 1 year ago)
- Language: Go
- Size: 79.1 KB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# http-services
HStreamDB's http-related services. Including:
- [http server](#http-server)
## Installation
- You can download the binary release suitable for your system
- Or you can build from source code
```shell
git clone git@github.com:hstreamdb/http-services.git
cd http-services
make all
```
then you can find the binary in `{project_dir}/bin`
## HTTP SERVER
The http server of HStreamDB provides the relevant api for accessing the HStreamDB service through http requests.
### Usage
- First, you need to confirm `HStreamDB` cluster is up.
- To set up a `HStreamDB` cluster, you can see [Manual Deployment with Docker](https://hstream.io/docs/en/latest/deployment/deploy-docker.html) and deployment related part.
- Start `http-server`：`./bin/http-server -services-url `
- Use `http-server -h` to see more details.
### Generate Swagger
- `make swag`
- Then you can start the server and go to http://localhost:8080/v1/swagger/index.html to see your Swagger UI.