Skip to content

Itz-fork/Nexa-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nexa API 🌊

Simple, Free and Easy to use Public api


Endpoints

Deployment

Development

List of endpoints 🎗️

  • Search

  • Language

    • acronym - Get the meaning of an acronym
    • define - Get the definition of a word
    • translate - Translate text using google translate
  • Tools

    • password - Generates a random password according to the given length
    • color_palette - Generate color palettes from images
    • currency - Exchange rate from 'x' to 'y'. Data is scraped from x-rates
  • File server

  • Fun

    • fact - Get a random fact
    • insult - Insult somebody ( ✧≖ ͜ʖ≖)

Deploy it! 🚀

This api is open source, you can deploy your own version easily 🤗

Locally 💻,

git clone https://github.com/Itz-fork/Nexa-API
cd Nexa-API
pip3 install -r requirements.txt
bash start.sh

Heroku ☁️

Deploy

Development 🧑‍💻

Here are somethings to note,

  • You can find api wrappers in wrappers directory
  • You can find config files in config directory
  • Reusable functions are located in functions directory
  • You can find routes in routes directory
  • Use start script when running the dev server (bash start.sh dev)

Add new routes 👨‍🎨

  • Create a new file in routes directory (Ex: myRoute.py)
  • Add this code (Here we add new route named /test which returns the text, Hello from Fastapi, Nexa API 🌊)
from fastapi import APIRouter
from ..functions.response import send_response

route = APIRouter()

@route.get("/test")
async def test_route():
    return await send_response("Hello from Nexa API 🌊")
  • Start the development server
bash start.sh dev

License & Credits 👮‍♂️ ♥️