Skip to content
/ pixum Public

Pixiv artwork API built with Axum

License

Notifications You must be signed in to change notification settings

astral4/pixum

Repository files navigation

Pixum

Pixum is a Pixiv artwork API built with Axum, a Rust web framework. Redis is used for caching image URLs. The application is containerized with Docker and Docker Compose.

API reference

  • /: Introduction page
  • /:id: Gets information about the work with content ID id
  • /:id/:num: Gets the image at content ID id on page number num

Quickstart

To run the app locally:

  1. Make sure Docker Compose is installed
  2. Run docker compose up (or docker-compose up if using Compose standalone)
  3. Go to localhost:3000

Acknowledgments

This project was inspired by pixiv.cat.

About

Pixiv artwork API built with Axum

Resources

License

Stars

Watchers

Forks