api-brawl-stars

command module
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2023 License: MIT Imports: 5 Imported by: 0

README

The Brawl Stars API

The Brawl Star API is a RESTful API based on the supercell video game Brawl Stars. You will access data about characters, images.

Prerequisites

  • Go (v1.17 o superior)
  • Fiber (v2)

Installation

  1. Clone this repository: git clone https://github.com/itsbeensolong/api-brawl-stars.git
  2. Navigate to the project directory: cd api-brawl-star
  3. Start the server: go run .
Endpoints
  • GET /api/: .
  • GET /api/:id: .
  • POST /api: .
  • PUT /api/:id: .
  • DELETE /api/:id: .

Use

Make sure you have started the server before making any requests to the API. The API will be available in 'http://localhost:8080'.

Errors

The API may return the following status codes and error messages:

404 Not Found: The requested resource was not found.
500 Internal Server Error: Error Server.

Contribution

If you'd like to contribute to this API, feel free to submit pull requests or report issues in the GitHub repository: https://github.com/itsbeensolong/api-brawl-stars

License

This project is licensed under the MIT License.

Contact

For inquiries or more information, you can contact me at johancs.mm@gmail.com

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL