https://github.com/eugene-matvejev/schema-battleship

JSON schemas of the responses|requests for the battleship-game-api
https://github.com/eugene-matvejev/schema-battleship

composer-package jest json json-schema npm-package yarn-packages

Last synced: 20 days ago
JSON representation

JSON schemas of the responses|requests for the battleship-game-api

• Host: GitHub
• URL: https://github.com/eugene-matvejev/schema-battleship
• Owner: eugene-matvejev
• Created: 2017-08-22T09:53:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-28T13:06:47.000Z (about 5 years ago)
• Last Synced: 2024-11-05T18:55:44.251Z (2 months ago)
• Topics: composer-package, jest, json, json-schema, npm-package, yarn-packages
• Language: JavaScript
• Size: 71.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[circle.ci-master-badge]: https://circleci.com/gh/eugene-matvejev/schema-battleship/tree/master.svg?style=svg

[circle.ci-master-link]: https://circleci.com/gh/eugene-matvejev/schema-battleship/tree/master

|                     | master

|---                  |---

| __stub validation__ |

| _< Circle CI >_     | [![build][circle.ci-master-badge]][circle.ci-master-link]

# Battleship Game API responses/requests JSON schemas

the purpose of this repository is to store JSON schemas for the API responses|requests of the [battleship-game-api](https://github.com/eugene-matvejev/battleship-game-api) as well as some stubs which represets business logic _as schema can't always represent business logic_

so whenever you're testing front-end or back-end you can relay on schemas and stub - instead of using real back-end for request/receive data

_every JSON file is stored in_ '__PRETTY' format__

stubs are validated against schemas on every Pull Request | Commit

## THIS IS SPARE TIME PROJECT, WORK IN PROGRESS! HIGHLY EXPERIMENTAL!!!

## used technologies

 * node.js

 * jest

 * npm

 * yarn

 * composer

 * json

 * json schema

## how to install

 * php, composer

 composer provides opportunity to checkout [additional sources of the packages](https://getcomposer.org/doc/05-repositories.md#loading-a-package-from-a-vcs-repository)

 add another source into your __composer.json__:

 ```

 repositories": [

     { "type": "vcs", "url": "https://github.com/eugene-matvejev/battleship-game-api-json-schema" }

 ],

 ```

 `$ composer install eugene-matvejev/battleship-game-api-json-schema` consider use `--dev` flag to add in _devDependencies_ section

 * node.js, npm|yarn

  WIP

## how to run tests

 * `$ npm test`