Code Monkey home page Code Monkey logo

rust-api's Introduction

rust-api

A simple API made with Rust!

Table of content

Overview

Rust API is an API created for my studies on rust and REST APIs.

This api stores a user creation system, as well as a login system with authentication and validation of parameters, functions such as listing users, editing and deleting them.

Stack

Usage

After downloading the source code, run the following command to download the dependencies and build the project:

cargo build

Then set these environment variables in .env file:

HOST="127.0.0.1"
PORT=3000
DATABASE_URL=
JWT_SECRET=

Then run the following command to run the server:

cargo run

API

Create users

POST /users

Fields:

{
    "username": "[USERNAME]",
    "email": "[EMAIL]",
    "password": "[PASSWORD]"
}

Response:

{
    "id": "[ID]",
    "username": "[USERNAME]",
    "email": "[EMAIL]"
}

List users

GET /users

Response:

[
    {
        "id": "[ID]",
        "username": "[USERNAME]",
    },
    ...
]

List user info

GET /users/{ID}

Response:

{
    "id": "[ID]",
    "username": "[USERNAME]",
    "email": "[EMAIL]"
}

Login user

POST /login

Fields:

{
    "email": "[EMAIL]",
    "password": "[PASSWORD]"
}

Response:

{
    "token": "[TOKEN]"
}

Update user

PUT /users Requires authentication

Fields:

{
    "username": "[USERNAME]",
    "email": "[EMAIL]",
    "password": "[PASSWORD]"
}

Response:

{
    "message": "User updated successfully!"
}

Delete user

DELETE /users Requires authentication

Fields:

{
    "password": "[PASSWORD]"
}

Response:

{
    "message": "User deleted successfully!"
}

rust-api's People

Contributors

luishenriquefa14 avatar

Stargazers

 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.