Skip to content

Latest commit

 

History

History
140 lines (81 loc) · 3.41 KB

README.md

File metadata and controls

140 lines (81 loc) · 3.41 KB
Raw

restjester BETA

REST API mocking server

  • You don't like mocking API REST calls, you want the real thing, sorta.
  • Cheap backend for SPA development
  • Single golang binary to just download and run, no installation.
  • Same solution for all languages.
  • Because you have to use an external API if your tests are driving a browser.
  • Can run as command line or system service.

Install

Download the server compiled for your architecture

[OSX] (https://github.com/kswope/restjester/blob/sync/releases/darwin/amd64/restjester?raw=true)

[Linux 386] (https://github.com/kswope/restjester/blob/sync/releases/linux/386/restjester?raw=true)

[Linux x86-64] (https://github.com/kswope/restjester/blob/sync/releases/linux/amd64/restjester?raw=true)

[Linux ARM] (https://github.com/kswope/restjester/blob/sync/releases/linux/arm/restjester?raw=true)

[Linux ARM64] (https://github.com/kswope/restjester/blob/sync/releases/linux/arm64/restjester?raw=true)

[Windows] (https://github.com/kswope/restjester/blob/sync/releases/windows/amd64/restjester?raw=true)

If you want/need to compile your own binary

Install golang, download this repo, run 'make', the binary will be in server/bin/

Run

With output to terminal

shell> ./restjester
Starting server at port 5351

As a daemon (requires deamon)

shell> deamon --name restjester ./restjester

Complete Functionality

  • POST values to / to install endpoints

    • path ( required )
    • method ( optional, default is GET )
    • status ( optional, default is 200 )
    • data ( optional, string (probably json), body of response, default is "" )

  • Accessing endpoint with GET, POST, PUT, DELETE, etc returns the corresponding installed endpoint

  • GET / returns all endpoints

  • DELETE / clears all endpoints

Example in ruby using rest-client and rspec

it "can install and GET resource" do

  # install resource on restjester (GET is the default)
  RestClient.post 'localhost:5351', { path:'/users/1', data: {'username' => 'kswope'}.to_json }

  # GET resource
  response = RestClient.get 'localhost:5351/users/1' 
  expect( JSON.parse( response.body ) ).to eql( { 'username'=>'kswope' } )

end

Installing endpoint ruby examples

RestClient.post 'localhost:5351', { method:'GET'     path:'/users/1', data: {user: 'kswope'}.to_json }
RestClient.post 'localhost:5351', { method:'PUT',    path:'/users/1', status:200 }
RestClient.post 'localhost:5351', { method:'DELETE', path:'/users/1', status:403 }
RestClient.post 'localhost:5351', { method:'POST',   path:'/users',   status:200 }

GET all endpoints ruby example

RestClient.get 'localhost:5351'

Query string parameter order doesn't matter

RestClient.post 'localhost:5351', { method:'GET' path:'/users/1?a=1&b=2', data: {}.to_json }

response = RestClient.get 'localhost:5351/users/1?a=1&b=2' 

# same as
response = RestClient.get 'localhost:5351/users/1?b=2&a=1'

javascript examples

TODO

perl examples

TODO LATER

Viewing all endpoints in browser

Just to go localhost:5351

Tip: install a JSON viewer plugin like JSONView

Clearing all installed endpoints ruby example

RestClient.delete 'localhost:5351'