Skip to content

lotusotho/raccoon-api

Repository files navigation

The Raccoon API 🦝

A Rust-based REST API built with Axum dedicated to serving raccoon-related content, including images, memes, facts, videos, 3D models, etc...

Thanks to the api.racc.lol repo and Venqoi for a lot of the assets used in this project.

The API uses docker and make commands to easily host locally or remotely an instance

API Endpoints

The API is versioned (default v1).

Endpoint Description
GET /v1/ API root
GET /v1/health Health check
GET /v1/coon Random raccoon image
GET /v1/thiscoon/{id} Get raccoon image by ID
GET /v1/meme Random raccoon meme
GET /v1/thismeme/{id} Get meme by ID
GET /v1/vid Random raccoon video
GET /v1/thisvid/{id} Get video by ID
GET /v1/rotd Raccoon of the Day
GET /v1/fact Random raccoon fact - "en" (english - default)
GET /v1/fact/{locale} Random raccoon fact - "en" (english) or "es" (spanish)
GET /v1/model Random 3D model URL and attribution
GET /v1/sound Random raccoon sound
GET /v1/wiki Raccoon Wikipedia redirect
GET /v1/games Raccoon-related game release info

It also has a fallback handler that uses ApiError::NotFound

Contribute

New cool features will be added overtime! Feel free to open a new PR or issue if you'd like something added or have any ideas for a change!

New media is always welcomed!!!

About

The rusty everything-related raccoon api

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors