Skip to content

Latest commit

 

History

History
129 lines (95 loc) · 3.16 KB

README.md

File metadata and controls

129 lines (95 loc) · 3.16 KB

Blog API

A RESTful API for managing a simple blogging platform built with .NET 8, following clean architecture principles and best practices.

Features

  • Create and retrieve blog posts
  • Add comments to blog posts
  • Clean Architecture implementation
  • Docker support
  • PostgreSQL database
  • Swagger documentation

Prerequisites

  • Docker and Docker Compose
  • .NET 8 SDK (for local development)
  • Make (optional, for using Makefile commands)

Getting Started

  1. Clone the repository:
git clone <repository-url>
cd blog-api
  1. Build the application:
make build
  1. Run the application:
make run

The API will be available at http://localhost:8080 and Swagger documentation at http://localhost:8080/swagger.

Configuration

The application requires configuration for database connection and JWT authentication. Sensitive information is not included in the version control.

Database Configuration

  1. Create a appsettings.Development.json file in the root directory (if it doesn't already exist). This file will override the default appsettings.json during development.
  2. Add the database connection string to the appsettings.Development.json file, replacing the placeholders with your actual values:
{
  "ConnectionStrings": {
    "PgSqlConnection": "Server=localhost;Port=5432;Database=blogdb;User ID=your-user-ID;Password=your-password;Pooling=true;"
  }
}

Note: Ensure your PostgreSQL server is running and accessible at the specified address and port.

JWT Configuration

Add the JWT configuration to the appsettings.Development.json file, replacing the placeholder with a strong, secure signing key:

JSON

{
  "JWT": {
    "SigningKey": "your-strong-signing-key"
  }
}

Note: Choose a long, random string for the signing key. Avoid using easily guessable values.

Token Generation

The API provides a simple way to generate a JWT token.

Generating a Token

To obtain a JWT token, send a GET request to:

GET /api/v1/auth/token

Response

{
  "message": "Token generated successfully",
  "data": "your-jwt-token"
}

Using the Token

Once you receive the token, include it in the Authorization header as a Bearer token in all API requests:

GET /api/v1/posts
Authorization: Bearer your-jwt-token

Swagger Authentication

To test authenticated endpoints via Swagger:

  1. Open http://localhost:8080/swagger.
  2. Click Authorize (lock icon).
  3. Enter your token as:
Bearer your-jwt-token
  1. Click Authorize and close the modal.

Now, you can send authenticated requests through Swagger.

API Endpoints

  • GET /api/v1/posts
  • POST /api/v1/posts
  • GET /api/v1/posts/{id}
  • POST /api/v1/posts/{id}/comments

Next Steps

  • Improve authentication with register and login endpoints
  • Create unit tests for the services and controllers
  • Update the Swagger documentation with more configurations
  • Create projects for the layers replacing the folders structure
  • Implement cache in the get endpoints based on the API's scalability
  • Improve the logging and tracing
  • Implement production monitoring to detect issues and performance bottlenecks