Code Monkey home page Code Monkey logo

quote-api's Introduction

Quote API

The Quote API is a simple RESTful API that allows you to fetch and create quotes. It provides endpoints to retrieve random quotes, fetch quotes by author, and add new quotes.

This is part of Codecademy's Full-Stack Engineer Career Path.

Getting Started

To get started with the Quote API, follow these steps:

  1. Clone the repository.
  2. Install the dependencies by running npm install.
  3. Start the server by running node server.js.
  4. The server will start running on http://localhost:4001.

Endpoints

The Quote API provides the following endpoints:

GET /api/quotes/random

Returns a random quote from the collection of quotes.

Example response:

json { "quote": "The greatest glory in living lies not in never falling, but in rising every time we fall.", "person": "Nelson Mandela" }

GET /api/quotes?person={author}

Returns quotes by the specified author.

Example request: /api/quotes?person=Nelson Mandela

Example response:

json { "quotes": [ { "quote": "The greatest glory in living lies not in never falling, but in rising every time we fall.", "person": "Nelson Mandela" }, { "quote": "It always seems impossible until it's done.", "person": "Nelson Mandela" } ] }

POST /api/quotes?quote={quote}&person={author}

Adds a new quote to the collection.

Example request: /api/quotes?quote=Be yourself; everyone else is already taken.&person=Oscar Wilde

Example response:

json { "quote": "Be yourself; everyone else is already taken.", "person": "Oscar Wilde" }

Dependencies

The Quote API uses the following dependencies:

  • Express: A fast and minimalist web framework for Node.js.
  • Morgan: A middleware for logging HTTP requests.
  • Nodemon (devDependency): A utility that automatically restarts the server when changes are made during development.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

quote-api's People

Contributors

rafaelfalleiros avatar

Watchers

 avatar

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.