Skip to content

xpodev/image-server-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

Image Placeholder API Documentation

API Endpoint

The API endpoint for generating placeholder images is: https://img.xpo.dev/{width}x{height}

This will generate a placeholder image with the specified width and height.

For example:

API Limitations

There are a few limitations and potential errors to note:

  • The maximum image size is 15000x15000 pixels. If the requested size exceeds the maximum, an error will be returned.
  • If the requested size is invalid, such as having negative values or not following the format {width}x{height}, an error will be returned.

Error Responses

If an error occurs, the API will respond with an appropriate error message. The response will have a JSON format:

{
  "error": "Error message"
}

Example

Here's an example of using the Image Placeholder API:

<img src="https://img.xpo.dev/400x300" alt="Example Image" class="example-img" width="400" height="300">

Example Image


Submitting Issues

If you encounter any issues or have suggestions for improvement, please submit them on the GitHub issue tracker for this project.


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published