Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.27 KB

README.md

File metadata and controls

49 lines (32 loc) · 1.27 KB

Files.com Mock API Server (in Ruby)

This serves a mock Files.com API server, which is useful for testing things like the Files.com SDKs and other direct integrations against the Files.com API.

It is built as a simple Grape app with generated definitions for each API endpoint.

This is meant as a minimal server for the purpose of testing basic network operations and JSON encoding for your SDK or API client. It does not maintain state and it does not deeply inspect your submissions for correctness.

Eventually we will add features intended for integration testing, such as the ability to intentionally provoke errors.

Requirements

  • Ruby 3+

Local Ruby Usage

bundle install
bundle exec puma

Docker Image Usage

We also supply a docker image for easier accessibility. First install docker; then, execute the following:

docker run -p 40410:4041 -it filescom/files-mock-server:latest

The image will be pulled from docker-hub, and the mock server can be accessed via the open port bound on the host machine.

Example:

curl 127.0.0.1:40410/api/rest/v1/users

Getting Support

The Files.com team is happy to help with any issues you may have running the Files.com mock server.

Just email support@files.com and we'll get the process started.