Giter Site home page Giter Site logo

stoic-snapshots's Introduction

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.


Quotes and Authors REST API

This API provides access to a collection of quotes and authors.

Endpoints

1. List Quotes

Endpoint: /api/quotes

Method: GET

Query Parameters

Parameter Required Description
offset No Offset for pagination (default: 0)
limit No Limit for pagination (default: 10)
author_id No Filters the quotes by the specified author_id

Response

Field Type Description
offset Number The starting point for pagination
limit Number The maximum number of quotes to retrieve
results Array An array of quote objects (Quote Object)
total Number The total number of quotes available

2. Get Quote by ID

Endpoint: /api/quotes/[quote_id]

Method: GET

Response

Field Type Description
id Number The unique identifier for the quote
quote String The text of the quote
author_id Number The unique identifier for the author
first_name String The first name of the author
last_name String The last name of the author
image_url String The URL of the author's image

3. Get Random Quote

Endpoint: /api/quotes/random

Method: GET

Query Parameters

Parameter Required Description
quote_id No Quote ID to exclude from random selection

Response

Quote Object

4. List Authors

Endpoint: /api/authors/

Method: GET

Query Parameters

Parameter Required Description
offset No Offset for pagination (default: 0)
limit No Limit for pagination (default: 10)

Response

Field Type Description
offset Number The starting point for pagination
limit Number The maximum number of authors to retrieve
results Array An array of author objects (Author object)
total Number The total number of authors available

5. Get Author by ID

Endpoint: /api/authors/[author_id]

Method: GET

Response:

Field Type Description
id Number The unique identifier for the author
first_name String The first name of the author
last_name String The last name of the author
image_url String The URL of the author's image

Rate Limiting

The API employs a sliding window rate limiting strategy, allowing 100 requests per minute per client.

stoic-snapshots's People

Contributors

mafzal91 avatar

Stargazers

breadfish_18 avatar Andrei Zvonkov avatar Peter Knittl-Frank avatar  avatar

Watchers

 avatar

Forkers

nick777-pixel

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.