3.3 KiB
NeoFS is a decentralized distributed object storage integrated with the NEO Blockchain.
neofs-rest-gw
NeoFS REST Gateway bridges NeoFS internal protocol and REST API server.
Installation
Building
Before building make sure you have the following tools:
- go
- make
- jq
- git
- curl
To build neofs-rest-gw call make the cloned repository (the binary will end up in bin/neofs-rest-gw).
Notable make targets:
dep Check and ensure dependencies
image Build clean docker image
image-dirty Build dirty docker image with host-built binaries
formats Run all code formatters
lint Run linters
version Show current version
generate-server Generate boilerplate by spec
Docker
Or you can also use a Docker image provided for released
(and occasionally unreleased) versions of gateway (:latest points to the latest stable release).
Execution
REST gateway itself is not a NeoFS node, so to access NeoFS it uses node's gRPC interface and you need to provide some
node that it will connect to. This can be done either via -p parameter or via REST_GW_PEERS_<N>_ADDRESS and
REST_GW_PEERS_<N>_WEIGHT environment variables (the gate supports multiple NeoFS nodes with weighted load balancing).
If you're launching REST gateway in bundle with neofs-dev-env, you can get
an IP address of the node in output of make hosts command
(with s0*.neofs.devenv name).
These two commands are functionally equivalent, they run the gate with one backend node (and otherwise default settings):
$ neofs-rest-gw -p 192.168.130.72:8080
$ REST_GW_PEERS_0_ADDRESS=192.168.130.72:8080 neofs-rest-gw
It's also possible to specify uri scheme (grpc or grpcs) when using -p:
$ neofs-rest-gw -p grpc://192.168.130.72:8080
$ REST_GW_PEERS_0_ADDRESS=grpcs://192.168.130.72:8080 neofs-rest-gw
Configuration
In general, everything available as CLI parameter can also be specified via environment variables, so they're not
specifically mentioned in most cases (see --help also). If you prefer a config file you can use it in yaml format.
See config and defaults for example.
$ neofs-rest-gw --config config.yaml
Docs
You can see additional docs and swagger specification using the following url
(suppose you ran rest-gw on localhost:8090):
- http://localhost:8090/docs - rest-gw documentation
- http://localhost:8090/v1/docs - swagger specification
Contributing
Feel free to contribute to this project after reading the contributing guidelines.
Before starting to work on a certain topic, create a new issue first, describing the feature/topic you are going to implement.