https://github.com/r3code/fake-take

Simple REST API read only server to test Single Page Application
https://github.com/r3code/fake-take

go golang http-api-testing http-server rest-api simple vuejs

Last synced: 2 months ago
JSON representation

Simple REST API read only server to test Single Page Application

• Host: GitHub
• URL: https://github.com/r3code/fake-take
• Owner: r3code
• Created: 2019-02-12T13:51:42.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-09T11:16:36.000Z (over 6 years ago)
• Last Synced: 2023-04-04T11:52:50.091Z (over 2 years ago)
• Topics: go, golang, http-api-testing, http-server, rest-api, simple, vuejs
• Language: Go
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# fake-take                                                  

![Alt text](assets/fake-take-avatar.png?raw=true "Fake Take Logo")

Simple HTTP API read only server to test Single Page Application

Simulates HTTP API for testing Single Page Application, e.g. VueJs app. 

Typically a reply is a 'application/json' format but you can use anything you want by passing the '-contentType' param.  Allows only "GET" requests. 

## Setup

API root path by default '/api/v1.0/'  to set another root path use '-apiroot' param and set any prefix you want.

### Adding paths and response bodies

Create a file with a *.resp extension. Name it follow the rule below.

Any part of the name separated by one underscore '_' treated as url part before the slash '/'.

Example:

events_recent.resp will be transalted to /api/v1.0/events/recent    

_No query params supported!_

You can crate as many '*.resp' files as you want.

New files can be added during server work, no need to restart.

You can even change the contents in '*.resp' file - server always reads the file at request time.

Error 404 reported if '*.resp' file not exists.  

## Usage 

To see usage notes use `-help` flag.

You can set:

* -addr string - to which IP bind the server (default `localhost`), to bind all interfaces place empty value `""`

* -apiroot string - relative to the server root path (default `/api/v1`)

* -contentType string - content type for response (default "application/json")

* -ext string - extension for data files (default "resp")

* -port int  - server port to listen at (default 3000)

 

Compile the app with `go install` or just run with `go run main.go`

By default server starts at `localhost:3000` and API available at `http://localhost:3000/api/v1`.

Root '/' path always redirects to apiRoot.

At api root `http://localhost:3000/api/v1` you can see clickable link list of available API paths.

Example:                    

    Available paths to GET:

        /api/v1/events/history

        /api/v1/events/recent

## Dev env

Compile with Go 1.9.x and https://github.com/gin-gonic/gin