elman23/articleapi

Article REST API.

Article REST API

References

• REST API development
• Database connection
• Create and connect to PostgreSQL

Environment variables

Create a .env file in the home of the project. The content should look like (change the secret values!):

POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword
POSTGRES_DB=articlesDB
[email protected]
PGADMIN_DEFAULT_PASSWORD=mypassword

Run

With go run

You need to create the .env file mentioned above.

Run the program with the command (from the project directory):

source .env
go run cmd/main.go

Dockerized stack

Provide the .env file mentioned above.

Run the full stack with:

docker compose up -d

Middleware

The database stack is composed by the PostgreSQL database and the PgAdmin instance to manage it.

The middleware is provided as a Dockerized stack to be run with Docker compose. The reference file is database.yml in the database folder.

Start the middleware

Start the middleware:

docker compose -f middleware.yml up -d

Table creation

You can create the database tables with the initial.sql SQL script in the sql directory.

The content of the script is the following (in case you want to run it line by line):

CREATE TABLE articles (id VARCHAR(36) PRIMARY KEY, title VARCHAR(100) NOT NULL, description VARCHAR(50) NOT NULL, content VARCHAR(50) NOT NULL);

SELECT EXISTS (SELECT FROM pg_tables WHERE  schemaname = 'public' AND tablename = 'articles' );

CREATE TABLE IF NOT EXISTS  articles  (id VARCHAR(36) PRIMARY KEY, title VARCHAR(100) NOT NULL, description VARCHAR(50) NOT NULL, content VARCHAR(50) NOT NULL);

INSERT INTO articles (id,title,description,content) VALUES ('8617bf49-39a9-4268-b113-7b6bcd189ba2', 'Article 1', 'Article Description 1', 'Article Content 1');

Test

Test the API with curl.

curl http://localhost:8080
curl http://localhost:8080/articles
curl http://localhost:8080/articles/[PUT_THE_CORRECT_ID_HERE]
curl -X POST --data '{"Title":"Second","Desc":"Description","Content":"This is the fantastic content."}' --header 'Content-Type: application/json' http://localhost:8080/articles

ToDo

• Authentication (password + JWT).
• Hash user password in database.
• Dependency Injection and Inversion of Control (see here).
• Separate queries from endpoints.
• User management.
• Authorizations.