FrostFS REST Gateway for using FrostFS via REST API
Find a file
Denis Kirillov feaea15aa7 [] Add missed CORS
Allow X-Bearer-For-All-Users, X-Bearer-Lifetime headers.
Add CORS to /auth/bearer route.

Signed-off-by: Denis Kirillov <denis@nspcc.ru>
2022-10-07 11:23:25 +03:00
.github [] Cross compile build 2022-09-30 10:07:31 +03:00
cmd/neofs-rest-gw [] Fix tests 2022-08-30 16:45:50 +03:00
config [] Add documentation for defaults parameters 2022-08-12 09:57:28 +03:00
docs [] Add documentation for defaults parameters 2022-08-12 09:57:28 +03:00
gen [] Add missed CORS 2022-10-07 11:23:25 +03:00
handlers [] Add missed CORS 2022-10-07 11:23:25 +03:00
internal/util [] Support keys in eacl 2022-08-30 10:00:41 +03:00
metrics [] Use gauge instead of counter for metrics 2022-08-25 10:48:21 +03:00
spec [] Add missed CORS 2022-10-07 11:23:25 +03:00
static/docs [] Update doc url 2022-07-12 11:36:32 +03:00
templates [] Expose metrics 2022-08-11 18:14:30 +03:00
.gitignore [] Add basic structure and operations 2022-04-29 10:20:37 +03:00
.golangci.yml [] Add basic structure and operations 2022-04-29 10:20:37 +03:00
CHANGELOG.md [] Update CHANGELOG.md 2022-09-22 12:29:56 +03:00
CONTRIBUTING.md [] Add contribution guide 2022-08-11 15:53:29 +03:00
Dockerfile [] Update go version to 1.19 2022-08-30 16:45:50 +03:00
Dockerfile.dirty [] Add basic structure and operations 2022-04-29 10:20:37 +03:00
go.mod [] Update go.mod 2022-09-06 13:44:52 +03:00
go.sum [] Update SDK 2022-08-29 15:03:50 +03:00
LICENSE [] Add basic structure and operations 2022-04-29 10:20:37 +03:00
Makefile [] Cross compile build 2022-09-30 10:07:31 +03:00
README.md [] Add building in docker 2022-08-15 13:01:18 +03:00
VERSION Release v0.4.0 2022-08-30 12:12:45 +03:00

NeoFS

REST server to interact with NeoFS.


Report GitHub release (latest SemVer) License

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
  • git
  • curl
  • docker

First clone this repository:

$ git clone https://github.com/nspcc-dev/neofs-rest-gw

Then run make to build bin/neofs-rest-gw binary:

$ make

Or you can build it using docker:

$ make docker/all

Generate go-swagger boilerplate code

If you change the spec file you have to re-generate go-swagger server code.

You have several approaches:

  1. Run make. It automatically downloads swagger and generates boilerplate.
$ make
  1. Generate code separately:
$ make generate-server

Or using docker:

$ make docker/generate-server

Other targets

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):

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.

License

This project is licensed under the GNU GPL v3 License - see the LICENSE file for details.