Skip to content

uncenter/catppuccin-api

Repository files navigation

catppuccin-api

Soothing pastel REST API for querying Catpppuccin ports and metadata. Written in Rust, using the Axum framework, and deployed on Fly.io. Data is sourced from the two YAML metadata files, ports.yml and userstyles.yml, and somewhat restructured to combine the two sources.

Routes

/ports

Note

List all ports and userstyles, combined. Use the is-userstyle field to differentiate between the two.

Returns an object, where the keys are the port identifiers and the values are arrays of ports matching the identifier (userstyles and ports might have duplicate identifiers, e.g. mdbook).

/ports/:identifier

Returns an array of ports matching the identifier.

/collaborators

Returns an object, where the keys are the usernames and the values are objects containing collaborator information.

Note

Duplicate usernames between ports/userstyles are resolved by picking one to use, simply assuming they are identical.

/collaborators/:username

Returns an object of collaborator information.

/categories

Returns an object of category keys and values.

/categories/:key

Returns an object of category information.

/showcases

Returns an array of showcases.

/palette

Returns the color palette.

License

Apache-2.0

Releases

No releases published

Packages

No packages published