Coder Social home page Coder Social logo

js-rails-as-api-design-documentation-exercise-b-chicago-web-062419's Introduction

API Design Exercise - B

Part I - Backend API Documentation

In this repository, there is a Rails app. Your job is to explore that app (read and run the code) and write documentation for one of the resources. You should write your documentation in a markdown file.

Document the index endpoint of the Coffee resource. You should include information on:

  • how to access the resource
  • how to filter by origin
  • how to how to limit to some number of results
  • how to specify which page of results

Once you've finished writing the documentation, send the markdown file to your partner.

Part II - Build a Frontend Feature

Your partner will send you a markdown file documenting an API. Using that documentation, add the following feature to your frontend app.

  • When the user types in the dog search bar and presses the search button, fetch the dogs that match the input and display the information about the dogs from the API
  • When the user selects a different radio button for the ordering, fetch the dogs and display with the selected ordering

js-rails-as-api-design-documentation-exercise-b-chicago-web-062419's People

Contributors

rrcobb avatar dependabot[bot] avatar maxwellbenton avatar aspenjames avatar

Watchers

James Cloos avatar Kevin McAlear avatar  avatar Mohawk Greene avatar Victoria Thevenot avatar Belinda Black avatar Bernard Mordan avatar raza jafri avatar  avatar Joe Cardarelli avatar The Learn Team avatar Sophie DeBenedetto avatar  avatar Antoin avatar Alex Griffith avatar  avatar Amanda D'Avria avatar  avatar Nicole Kroese  avatar Kaeland Chatman avatar Lisa Jiang avatar Vicki Aubin avatar  avatar  avatar  avatar

Forkers

srwatlanta

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.