_{API for the labs project. Make with ❤︎}

FaceTattoo Projects API

API REST model that can be used in a variety of applications, in this example, and by default, it's running a model of an API REST for access 42 projects.

In this APiI we have a simple CRUD system in the /projects uri, and a simple authentication system in /users uri.

To be authenticated, you need to create a user with the POST method. With the body:

{
  "name": "YOUR_NAME",
  "password": "YOUR_PASSWORD"
}

Now that you have a user you, can use the uri /authentication with the same body to get your JWT Token.

And with this JWT Token you need to put a BEARER auth in a header of http request, now you can use the routes of the API to create and delete in the /project and use the methods PUT, POST and DELETE.

We have a demo page here

Table of contents

• Tech stack
• How to run
• How to test
• How to use the CLI
• Contribute
• License

What is this?

Tech stack

• ANSI C
• Docker
• GNU Make
• Mongoose web server
• OpenSSL
• Jansson
• MySQL
• Rhonabwy

How to run

You can run this API locally, but you will need to run in parallel a MariaDB container. We strongly recommend you to run it using our docker-compose.yml file to create 2 containers. In this method is needed you to change the IP in the file docker-compose.yml to match yours, otherwise you'll have database connection problem.

Requirements

This API REST has only Debian based linux support, and all that you need to run is the Docker and Docker Compose package.

DevTools for Debian/Ubuntu

In order to install the build essentials, run the following command:

sudo apt-get install docker && sudo apt-get install docker-compose

Method 1 - Use our container build

Simply run our docker-compose.yml file with the following command:

# This for getting the docker compose file:

wget https://raw.githubusercontent.com/Face-Tattoo/Api_Labs/main/docker-compose.yml\?token\=GHSAT0AAAAAABRADJ3ZMAQ7E3OQUC3FZZBMYQ3WKJQ -O docker-compose.yml

# Now change the docker compose file using the text editor of your like, in this example we will use vim. 

nano docker-compose.yml

# Now run the docker compose file, this may take a while depending on your internet connection. 

docker-compose -f "docker-compose.yml" up -d --build

Method 2 - Locally

Clone the repository and install all dependencies.

# Use the make install to install some dependencies, if some error occur, see the list of dependencies and try to install with another method. 

make install

# Now initialize the mariadb database container

docker run -d --name mariadb -p 3306:3306 -e MYSQL_ROOT_PASSWORD=mariadb -e MYSQL_DATABASE=42api mariadb:latest

# Or install mariadb locally too

sudo apt install mariadb-server
sudo mysql_secure_installation

# For the password root
mariadb

# Create a DB this will entry in your mariadb
mysql -pmariadb

# This will create the DB
CREATE DATABASE 42api;
exit

#Run the .sh file, this will create the tables in the DB and initialize the server. 
./run.sh

How to test

We create tests with Insomnia that is an application that create and test http request, this is not a automated test but it is functional to verify if the server is running and receiving API REST instructions.

• For this you will need to download Insomnia

• Then you will need to import the insomnia_tests.json from the repository.

• Open the Insomnia application.

• Go to the gear icon.

• In the Data file, select the import data option.

• Select From File and select the insomnia_tests.json file.

• In the dashboard enter in the document just created

• After that, go to the DEBUG tab and enter in the Dropdown menu No environment and Manage Environment

• In this file, you need to change the in the IP in the file with your machine IP, the same IP that you used in previous steps. It should look like this.

{
	"base_url": "YOUR_IP_HERE:8000",
}

• If in the middle of test you get any authentication problems, you should run the User Create and Authentication routes, in that order. After that you should go again in the dropdown No environment and Manage Environment, and paste your acquired token in the toke field. It should look like this.

{
	"base_url": "YOUR_IP_HERE:8000",
	"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjgwMH0.ddOza6DgJ92OvnC5v5sx1bGW7-9wMUk5Rbey9SxELDI"
}

• After that, go to the TEST tab and select Run Tests.

Development server

Development server is ready-only only if you used the Method-1. Making a development server using the Method-2 is counterproductive.

Using the CLI

The server logs can be accessed via the ada command line interface. This step assumes that the server is already running.

Running the CLI from within a docker container

This step assumes that you already have the server running in a docker container.

Execute Logs commands through the docker interface:

docker exec -it YOUR_DOCKER_NAME_api_1 Logs

You can also make an alias for that, to make this process easier:

alias Logs="docker exec -it YOUR_DOCKER_NAME_api_1 Logs"

Or you can use our other Cli thats use the Database logs for the Cli, this have more option to see the logs.

docker exec -it YOUR_DOCKER_NAME_api_1 Logs2 --help
# and create a alias out of the docker 
alias Logs2="docker exec -it YOUR_DOCKER_NAME_api_1 Logs2"

P.S: Remember to change the YOUR_DOCKER_NAME_api_1 to the name of your container. You can use the following command to know your docker name.

docker ps

Running the CLI locally

This step assumes that you followed the how to develop guide.

# inside of the repository folder
make logs_local

#this will create the to types of logs then you choose yours 
./Logs
# or
./Logs2

Contribute

This project was made by Luiz, Van and Paulo Enjoyed the application? Please, consider contributing to the project.

License

This project is under the GNU General Public License v3.