https://github.com/marcelog/minesweeper-api

https://github.com/marcelog/minesweeper-api

Last synced: about 11 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/marcelog/minesweeper-api
• Owner: marcelog
• Created: 2019-01-05T15:05:56.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-07T22:52:07.000Z (almost 6 years ago)
• Last Synced: 2024-11-16T06:58:27.439Z (about 2 months ago)
• Language: Go
• Size: 55.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# minesweeper-API

## Build

Install [golint](https://github.com/golang/lint) like:

```bash

go get -u golang.org/x/lint/golint

```

Then just:

```bash

make

```

It will run tools like [vet](https://golang.org/cmd/vet/), and

[golint](https://github.com/golang/lint), compile, run tests, format the code,

and open the coverage report.

## Running

After building the server (see above), just run either of:

* build/minesweeper-API-linux

* build/minesweeper-API-darwin

## API Docs

See [spec.yml](https://github.com/marcelog/minesweeper-API/blob/master/spec.yml)

which is in [Swagger](https://swagger.io) format.

## Basics

* Create a user by `POST`ing to `/users`. You get your user id and api key.

* Use the api key to authenticate to any protected endpoints by sending your api key in the `X-API-Key` header.