Code Monkey home page Code Monkey logo

rails-rest-api's Introduction

Rails RESTful API Primer

This project showcases an approach to building RESTful APIs using Ruby on Rails.

For now the main resource is a player, you know a participant in a sport.

Supported Functionality

Retrieving a list of players

GET /api/v1/players/

Retrieving an individual player

GET /api/v1/players/<player id>/

Creating a player record

POST/api/v1/players/ with a payload like:

{
    "first_name": "Jimmy",
    "last_name": "Connors",
    "country": "American",
    "birth_date": "1994-12-23"
}

Updating a player record

Partial update

PATCH /api/v1/players/<player_id>/ with a payload like:

{
    "first_name": "Jimmy",
}

Replacement

PUT /api/v1/players/<player_id>/

{
    "first_name": "John",
    "last_name": "McEnro",
    "country": "American",
    "birth_date": "1998-12-23"
}

Deleting a player

DELETE /api/v1/players/<player_id>/

Deleting a player record

  • Ruby version Ruby v3.3

  • System dependencies Unix-based OS

  • Configuration N/A

  • Database creation

$ rails db:create
$ rails db:migrate
$ rails db:seed:
  • How to run the test suite N/A

  • Services (job queues, cache servers, search engines, etc.) N/A

  • Deployment instructions N/A

rails-rest-api's People

Contributors

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