📈 Stock Market Portfolio API

A robust RESTful Web API built with .NET 8.0 for managing stock portfolios, including user authentication, stock tracking, comments, and portfolio management.

---

🚀 Features

• User Authentication — Secure registration and login with JWT tokens
• Stock Management — Full CRUD operations for stocks with filtering/sorting
• Comment System — Users can comment on stocks
• Portfolio Management — Track and manage user stock portfolios
• API Documentation — Interactive Swagger UI for testing endpoints

---

📦 Tech Stack

Technology	Purpose
ASP.NET Core 8.0	Web API Framework
Entity Framework Core 8.0	ORM & Database Access
SQL Server	Database
ASP.NET Identity	User Authentication
JWT Bearer Tokens	Authorization
Swagger/OpenAPI	API Documentation
Newtonsoft.Json	JSON Serialization

---

🗂️ Project Structure

API/
├── Controllers/          # API Endpoints
│   ├── AccountController.cs      # User registration & login
│   ├── StockController.cs        # Stock CRUD operations
│   ├── CommentController.cs      # Comment management
│   └── PortfolioController.cs    # Portfolio management
├── Models/               # Entity Models
│   ├── AppUser.cs               # User model (extends IdentityUser)
│   ├── Stock.cs                 # Stock entity
│   ├── Comment.cs               # Comment entity
│   └── Portfolio.cs             # Portfolio entity
├── Dtos/                 # Data Transfer Objects
│   ├── Account/                 # Login, Register, NewUser DTOs
│   ├── Stock/                   # Stock request/response DTOs
│   └── Comment/                 # Comment DTOs
├── Repository/           # Data Access Layer
│   ├── StockRepository.cs
│   ├── CommentRepository.cs
│   └── PortfolioRepository.cs
├── Interfaces/           # Repository Interfaces
├── Mappers/              # Entity <-> DTO Mappers
├── Helpers/              # Query objects & utilities
├── Extensions/           # Extension methods
├── Service/              # Token service
├── Data/                 # Database context
├── Program.cs            # Application entry point
├── appsettings.json      # Configuration
└── api.csproj            # Project file

---

🔌 API Endpoints

🔐 Authentication

Method	Endpoint	Description	Auth Required
POST	/api/Account/register	Register new user	✅
POST	/api/Account/login	Login & get JWT token	✅

📊 Stocks

Method	Endpoint	Description	Auth Required
GET	/api/stock	Get all stocks (with filters)	✅
GET	/api/stock/{id}	Get stock by ID	✅
POST	/api/stock	Create new stock	✅
PUT	/api/stock/{id}	Update stock	✅
DELETE	/api/stock/{id}	Delete stock	✅

Query Parameters for GET /api/stock:

• Symbol — Filter by stock symbol
• CompanyName — Filter by company name
• SortBy — Sort results by field
• IsDescending — Sort direction (true/false)

💬 Comments

Method	Endpoint	Description	Auth Required
GET	/api/comment	Get all comments	✅
GET	/api/comment/{id}	Get comment by ID	✅
POST	/api/comment/{stockId}	Add comment to stock	✅
PUT	/api/comment/{id}	Update comment	✅
DELETE	/api/comment/{id}	Delete comment	✅

📁 Portfolio

Method	Endpoint	Description	Auth Required
GET	/api/portfolio	Get user's portfolio	✅
POST	/api/portfolio?symbol=XXX	Add stock to portfolio	✅

---

🛠️ Getting Started

Prerequisites

• .NET 8.0 SDK
• SQL Server (or SQL Server Express)
• IDE: Visual Studio 2022 or VS Code

Installation

1. Clone the repository

   git clone <repository-url>
   cd API

2. Update the connection string

   Edit appsettings.json with your SQL Server details:

   {
     "ConnectionStrings": {
       "DefaultConnection": "server=YOUR_SERVER;database=YOUR_DATABASE;trusted_connection=true;TrustServerCertificate=true"
     }
   }

3. Configure JWT settings (optional)

   Update JWT settings in appsettings.json:

   {
     "JWT": {
       "Issuer": "http://localhost:5246",
       "Audience": "http://localhost:5246",
       "SigningKey": "your-secure-signing-key-min-64-chars"
     }
   }

4. Apply database migrations

   dotnet ef database update

5. Run the application

   dotnet run

6. Access Swagger UI

   Navigate to: https://localhost:5001/swagger or http://localhost:5000/swagger

---

🔒 Authentication Flow

1. Register a new user via POST /api/Account/register

   {
     "username": "johndoe",
     "email": "john@example.com",
     "password": "SecurePass123!"
   }

2. Login via POST /api/Account/login to receive JWT token

   {
     "userName": "johndoe",
     "password": "SecurePass123!"
   }

3. Use the token in subsequent requests:

   Authorization: Bearer <your-jwt-token>
   

Password Requirements

• Minimum 8 characters
• At least 1 uppercase letter
• At least 1 lowercase letter
• At least 1 digit
• At least 1 special character
• At least 1 unique character

---

📊 Data Models

Stock

Field	Type	Description
Id	int	Primary key
Symbol	string	Stock ticker symbol
CompanyName	string	Company name
Purchase	decimal	Purchase price
LastDiv	decimal	Last dividend
Industry	string	Industry sector
MarketCap	long	Market capitalization

Comment

Field	Type	Description
Id	int	Primary key
Title	string	Comment title
Content	string	Comment content
CreatedOn	DateTime	Creation timestamp
StockId	int	Related stock ID
AppUserId	string	Author user ID

Portfolio

Field	Type	Description
AppUserId	string	User ID (FK)
StockId	int	Stock ID (FK)

---

📝 Sample Requests

Create a Stock

curl -X POST "https://localhost:5001/api/stock" \
  -H "Content-Type: application/json" \
  -d '{
    "symbol": "AAPL",
    "companyName": "Apple Inc.",
    "purchase": 150.00,
    "lastDiv": 0.24,
    "industry": "Technology",
    "marketCap": 2500000000000
  }'

Get Stocks with Filtering

curl -X GET "https://localhost:5001/api/stock?Symbol=AAPL&SortBy=CompanyName&IsDescending=true" \
  -H "Authorization: Bearer <your-token>"

---

🧪 Testing with Swagger

1. Run the application
2. Open Swagger UI in your browser
3. Click Authorize button (🔐)
4. Enter: Bearer <your-jwt-token>
5. Test any endpoint interactively

---

📄 License

This project is open source and available under the MIT License.

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📧 Contact

For questions or suggestions, please open an issue in the repository.

---

Made with ❤️ using .NET 8.0