Code Monkey home page Code Monkey logo

quotes-api's Introduction

README

What is this API for?

This is a simple API that returns quotes from famous people. The data is returned in JSON format. It's free and doesn't need a key.

How to use it?

  • The API's endpoint is: /api/v1/ or /api/v1/quotes Returns the first 10 quotes in the database.
  • To navigate between pages: /api/v1/quotes?page=:number
  • /api/v1/quotes/:id returns the quote that belongs to the id given
  • The search function's endpoint is api/v1/search/?q=:person. The query only accepts the person name
  • The random function returns a random quote and its endpoint is: api/v1/random/
Returned fields
  • id: The id of the quote
  • person: Person who belongs the quote
  • quote: The quote itself
  • created_at: When was created in the database
  • updated_at: When was updated in the database

How to deploy it?

To test locally, install dependencies using bundle install.

After that run the command rails db:migrate to create and initialize the database, populate the database with rails db:seed and then run the API using rails s or rails server.

The API will be running on localhost:3000.

Ruby version 2.6.4 Ruby on Rails 6 SQLite for development PostgreSql for production

quotes-api's People

Contributors

rafagars 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.