Giter VIP home page Giter VIP logo

apicit's Introduction

Api Base

Descripción

  • Api base para comenzar desarrollo.

Características

  • Registro de usuarios(Autenticación) mediante JWT
  • Autorización mediante la gema Cancancan
  • Avatar de usuario mediante la gema Carrierwave (Imagen por defecto para cada usuario)
  • Versionamiento mediante Concerns en routing
  • Prevención de requests masivas mediante la gema rack-attack

Usuario Admin por defecto

Endpoints

  • Registro
api/v1/sign_up
  • Autenticación
api/v1/sign_in
  • Usuario actual
api/v1/auth
  • Usuarios (Solo administrador puede ver este endpoint)
api/v1/admin/users
  • Eliminar/Editar/Ver Usuario (Requiere token)
v1/users/USERNAME

Ejemplos

  • Registro de usuario (devuelve token asi evitar enviar 2 request para obtener token al registrarse)
curl -H 'Content-Type: application/json' -d '{"user": {"email": "emaildomain.com","password": "password","password_confirmation":"password", "username":"user_example"}}' localhost:3000/api/v1/sign_up
  • Autenticación de usuario (devuelve token)
curl -H 'Content-Type: application/json' -d '{"auth": {"email": "[email protected]","password": "password"}}' localhost:3000/api/v1/sign_in
  • Usuario actual (devuelve username actual)
curl -H 'Content-Type: application/json' -H 'Authorization: JWT' localhost:3000/api/v1/auth
  • Subir/Editar avatar usuario
curl -X PATCH -v -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -H 'Authorization: JWT' -F "user[avatar]=@/PATH_FILE" localhost:3000/api/v1/users/USERNAME
  • Editar usuario
  • Campos : email, username, etc..
  • Para actualizar la contraseña se requiere de los campos:
  • current_password, password, password_confirmation
curl -X PATCH -H 'Content-Type: application/json' -H 'Authorization: JWT' -d '{"user": {"email":"[email protected]"}}' localhost:3000/api/v1/users/USERNAME
  • Eliminar usuario
  • Posibilidad de dar cuenta de baja (Administrador puede eliminar cualquier usuario)
curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization: JWT' localhost:3000/api/v1/users/USERNAME
  • Ver usuario en particular
curl -H 'Content-Type: application/json' -H 'Authorization: JWT' localhost:3000/api/v1/users/USERNAME
  • Listar usuarios
  • Solo el usuario con rol "admin" puede modificar/eliminar a otros usuarios además de listarlos.
curl -H 'Content-Type: application/json' -H 'Authorization: JWT' localhost:3000/api/v1/admin/users

Instalación

bundle install
rails db:create
rails db:migrate
rails db:seed
rails server

apicit's People

Contributors

jamesandrescm avatar geenstijl1 avatar

Watchers

James Cloos avatar  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.