Proverbs API

Usage

To use this API, make HTTP requests to the endpoints listed below. Make sure to handle responses and errors appropriately in your application.

Restrictions

Since this project is a free to use hobby project it has some restrictions because I use the free plan of render.com

• Limited Resources

  The API has limited CPU and memory resources. This can affect the performance, especially under heavy load.

• Usage Limits

  There's only a certain amount of free usage per month. Exceeding this limit may result in service disruption.

• Inactivity

  The API is suspended after 15 minutes of inactivity. This means the first request after inactivity may take longer to respond.

• Database Limitations

  DB has limitations on the number of connections and performance.

Endpoints

• GEThttps://jad-russian-proverb-api.onrender.com/proverbs/random Get a random proverb.

• GEThttps://jad-russian-proverb-api.onrender.com/proverbs/specific/1 Get a specific proverb by id.

• GEThttps://jad-russian-proverb-api.onrender.com/proverbs/categories Get all categories.

• GEThttps://jad-russian-proverb-api.onrender.com/proverbs/category/Work Get proverbs by category.

Example Response

  {
    "id": 1,
    "russianProverb": "Не откладывай на завтра то, что можно сделать сегодня.",
    "englishTranslation": "Do not put off till tomorrow what may be done today.",
    "meaningExplanation": "Explanation of the proverb meaning.",
    "category": "WISDOM"
  }
        

Swagger

For a more thorough usage and for testing purpose you can access the swagger UI via Link.