/screener-api

Screener REST API to monitor exchanges.

Primary LanguageJavaMIT LicenseMIT

Screener REST API.

We recommend IntelliJ IDEA EO principles respected here

Maintainability Codacy Badge codecov Hits-of-Code issues license

User guide.

1. Registration

URI http://api/user/registration

Request type: POST

Request must contain email and password

Response type: JSON

HTTP statuses:

  • CREATED
  • CONFLICT
  • BAD_REQUEST

Response contains UserEntity

{
 "email":"example@gmail.com",
 "password": "example",
 "rate": "free",
 "expiration": null
}

2. Authentication

URI http://api/user/authentication

Request type POST

Request must contain email and password

Response type: JSON

HTTP statuses:

  • OK
  • NOT_FOUND
  • UNAUTHORIZED
  • BAD_REQUEST

Response contains UserEntity

{
 "email":"example@gmail.com",
 "password": "example",
 "rate": "free",
 "expiration": null
}

Contribution

How to contibute?

  • Create a fork
  • Create a branch
  • Do improvments
  • Send pull request

Run mvn clean install before sending a pull request to avoid confusing situations.

Docker image

Link to DockerHub.