mr-conos / rock-api

An API for viewing rocks and rating them

Rock API Docs

---

What is Rock API?

Rock API is an API that allows you to view rocks and find the ratings on them. However, this isn't a regular "rock finding" API... We have rocks like, glow rock, falling rock, and MANY more. This api we made for entertainment purposes. Use this API in your Discord bot for commands like pls rock or !randomrock or even in your website for... something.

---

Links

🔗 - API and Docs - https://rockapi.apiworks.tech

🔗 - Discord Server - https://discord.gg/EPQQDAJjGv

⭐ Thank you to snapGar#4786 (Discord) for drawing rocks!

💁‍♂️ DM me on Discord at Conos#9079 if you have more questions or join the discord server. :)

rock-api's Issues

API Structure

Resource

Why not use FastAPI to create the API? FastAPI offers more resources.

Build

Moreover, the architecture of this project can be better

Rock-API
│   README.md 
│
└───api
│   │   main.py   
└───tests
    │   test1.py
    │   test2.py

And the architecture of the API itself can be improved too

mrconos.pythonanywhere.com/rock

• /post - upload a new rock
• /random - get a random rock from the API
• /get - get a specific rock by name/ID

Other features that can be added

• An unique ID for every rock
• Search for rocks
• Rocks upload and receive by base64

Readme.MD BaseURL broken.

https://mrconos.pythonanywhere.com/rock/ Has a 404.

There was a frog in the API.

Describe the bug
The API is supposed to send you a picture of a rock. There was a frog.

To Reproduce
Steps to reproduce the behavior:

1. Go to https://mrconos.pythonanywhere.com/rock/random
2. Constantly reload until you get something like {"name": "frogg", "desc": "Definitely a rock.", "image": "https://tinyimg.io/i/VRWsyTb.png", "rating": 4}.

Expected behavior
There should be no frog.

Screenshots

Desktop (please complete the following information):

• OS: Microsoft Windows 10 Home 10.0.19043 Build 19043
• Browser: 101.0.4951.67 (Official Build) (64-bit) (cohort: Stable)

when is rockapi coming up?

Its been almost an year and i dont see it being active.. please bring it up again

[Workflow Suggestion] Formatting with `black`

I suggest using the black formatter (pip install black) for this project.

Motive

black is an unforgiving formatter, that meaning it's extremely consistent with it's guidelines. I think this consistency in style would be appreciated by other developers working on this project.

Installation

$ pip install black
or
$ python3 -m pip install black

Usage

$ black .
or
$ python3 -m black .

Externals

https://github.com/psf/black
https://pypi.org/project/black/

Documentation tells you to use a deprecated library. (request)

The node package "request" is deprecated.

https://www.npmjs.com/package/request

I'd recommend changing the documentation to either have examples using node-fetch or axios instead.

node-fetch: https://www.npmjs.com/package/node-fetch
axios: https://www.npmjs.com/package/axios