Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yukitas/rails-rest-api
A simple RoR 6 REST API demo with JWT authentication.
https://github.com/yukitas/rails-rest-api
github-actions jwt rails rails6 rest-api restful ruby ruby-on-rails sqlite3
Last synced: 8 days ago
JSON representation
A simple RoR 6 REST API demo with JWT authentication.
- Host: GitHub
- URL: https://github.com/yukitas/rails-rest-api
- Owner: YuKitAs
- License: gpl-3.0
- Created: 2018-03-23T18:05:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T19:13:10.000Z (6 months ago)
- Last Synced: 2024-10-29T14:15:17.423Z (16 days ago)
- Topics: github-actions, jwt, rails, rails6, rest-api, restful, ruby, ruby-on-rails, sqlite3
- Language: Ruby
- Homepage:
- Size: 178 KB
- Stars: 31
- Watchers: 3
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rails Rest API
## Project Setup
**Install all gems**:
```console
$ bundle install
```
**Update the database with new data model**:
```console
$ rake db:migrate
```
**Feed the database with default seeds**:
```console
$ rake db:seed
```
**Start the web server on `http://localhost:3000` by default**:
```console
$ rails server
```
**Run all RSpec tests and Rubocop**:
```console
$ rake test
```
## Usage
| HTTP verbs | Paths | Used for |
| ---------- | ------ | --------:|
| POST | /register| Create a user|
| POST | /login | Authenticate a user |
| GET | /posts | List all posts|
| GET | /posts/:post_id | Show a single post |
| POST | /posts | Create a post |
| PUT | /posts/:post_id | Update a post |
| DELETE | /posts/:post_id | Delete a post |
| GET | /posts/:post_id/comments | List all comments of a post |
| GET | /posts/:post_id/comments/:comment_id | Show a single comment |
| POST | /posts/:post_id/comments | Create a comment |
| PUT | /posts/:post_id/comments/:comment_id | Update a comment |
| DELETE | /posts/:post_id/comments/:comment_id | Delete a comment |
## Use Case Examples
### Authentication
**Create a new user**:
```console
$ curl -X POST -H 'Content-type: application/json' -d '{"email": "[email protected]", "password": "testuser123"}' localhost:3000/register
```
**Authenticate a user**:
```console
$ curl -X POST -H 'Content-type: application/json' -d '{"email": "[email protected]", "password": "testuser123"}' localhost:3000/login
```
On successful login, `{"auth_token": }` will be returned. This token will be expired after 24 hours.
### CRUD
**In order to access the posts and comments, add `-H 'Authorization: '` to the header of every request for CRUD operations.**
The `create`, `update` and `delete` actions can only be executed by users authorized on admin. A default admin user is definded in `db/seeds.rb`. After seeding the database, `{"email": "[email protected]", "password": "admin123"}` can be used to login as an admin.
**Create a new post**:
```console
$ curl -X POST -H 'Content-type: application/json' -d '{"title": "My title", "content": "My content"}' localhost:3000/posts
```
**Create a new comment**:
```console
$ curl -X POST -H 'Content-type: application/json' -d '{"name": "YuKitAs", "message": "My message"}' localhost:3000/posts/1/comments
```
The `name` field is optional with default value `anonym`.
**Update an existing post by id**:
```console
$ curl -X PUT -H 'Content-type: application/json' -d '{"title": "My new title", "content": "My new content"}' localhost:3000/posts/1
```
**Update an existing comment by id**:
```console
$ curl -X PUT -H 'Content-type: application/json' -d '{"name": "YuKitAs", "message": "My new message"}' localhost:3000/posts/2/comments/1
```
**Delete an existing post by id**:
```console
$ curl -X DELETE localhost:3000/posts/1
```
All the comments of this post will be deleted as well.
**Delete an existing comment by id**:
```console
$ curl -X DELETE localhost:3000/posts/2/comments/1
```