Delve into creating, optimizing, and securing a Rails API from scratch. Gain insights into building a full-fledged, efficient Rails API, ready for immediate use.

rails.tar.gz

Routes changes

validating_the_user_model

unit_tests

show_user

migration_file

create_tokens

feed_the_database

presentation_of_JSON_API

validating_the_order_model

list_orders

decrementing_product_quantity

extending_the_placement_model

feed_the_database-2

feed_the_database-3

Setting Up the Authentication Token

validating_the_product_model

unit_tests_for_order_model

the_placement_model

decrementing_product_quantity-2

activation_of_CORS

This course is a comprehensive tutorial that will teach you the best way to build your next API with Rails. You’ll learn to create a Rails API from scratch and to optimize and secure a Rails API. By the end of this course, you’ll have a full-fledged Rails API ready to be used.

Building your own API with Rails

We can test our endpoints using the existing resources. We have two users we can access:

- The first user has the email `toto@toto.org`. Its ID is `1` since it was the first resource created.
- The second one has the email `test@test.org`. Its ID is `2` since it was the second resource created.

We have several ways to test our endpoints. The one we will use in this course is `curl`, which is integrated into almost all Linux distributions. Let’s test each one of our endpoints using the `curl` command.


>**Note:** The database changes made in the widgets in this lesson are limited to these widgets.

# Test the `GET` function
Let’s test the `GET` function by following the instructions below.

import React from 'react';
import { shallow, configure } from 'enzyme';
import Adapter from 'enzyme-adapter-react-16';

configure({ adapter: new Adapter() });

import HelloWorld from './app';

var TestResult = function() {
    this.succeeded = false;
    this.reason = "";
    this.input = "";
    this.expected_output = "";
    this.actual_output = "";
}

export const executeTests = function() {

  var results = [];

  result = new TestResult();
  result.input = 'HelloWorld Component';
  result.expected_output = "span containing text 'Hello World'"

  let wrapper = shallow(<HelloWorld />);

  // Call your Challenge function here.

  let type = wrapper.type();
  let testSuccessful = true;
  let failureReason;

  if (type !== 'span') {
    testSuccessful = false;
    failureReason = "You need to render exactly one span HTML element";
  } else if (wrapper.props().children != "Hello World") {
     testSuccessful = false;
     failureReason = "You have rendered wrong message in your span element";
  }

  result.actual_output = wrapper.html();

  if (testSuccessful) {
    result.succeeded = true;
    result.reason = "Succeeded"
  } else {
    result.succeeded = false;
    result.reason = failureReason;
  }

  results.push(result);

  return results;
}


React

Dart

GoJS React

Typescript React

Vue.js

Click the "Run" button to open a terminal. Then open a new terminal by clicking the "$+$" button next to the "Terminal" tab. Initialize the `rails` server on the new terminal using:
```text
$ cd usercode/workspace/market_place_api && rails s
```

Then switch back to the first terminal and run the following:

```text
$ curl http://127.0.0.1:3000/api/v1/users/1
```

This command will display the information for the user with ID `1`. In our case, that is the user associated with `toto@toto.org`. We can access the information for the second user by changing the ID to `2`. To `GET` user `test@test.org`, run the command:
```text
$ curl http://127.0.0.1:3000/api/v1/users/2
```
Running `curl http://127.0.0.1:3000/api/v1/users/3` will give us an error since there are only two users.

We have now tested the `GET` operation of the API by using the `curl` command.
# Test the `POST` function
Now, let’s test the `POST` function by following the instructions below.

Learn to use the curl command to test functions.

Test Our Resources with curl

Getting Started

The API

User Model

Authenticating the Users

User's Products

Building JSON

Placing Orders

Improving Orders

Optimizations

Wrap up

Appendix

Test Our Resources with curl

Test the `GET` function

Test Our Resources with curl

Test the GET function

Test the `GET` function