API Reference Documentation

This document provides a comprehensive overview of the Personal Reading List API. The API is a RESTful service designed to help users manage their personal reading lists by saving articles, generating summaries, and organizing them with tags.

The full source code for this API is available on GitHub. This repository includes the Go backend, database schema, and the Swagger documentation:

https://github.com/jeana-hines/personal-reading-list-api

Introduction

The following sections cover the details of the endpoints of the Personal Reading List:

• /auth/register: Register a New User
• /auth/login: Log In
• /auth/logout: Log Out
• /articles: Get User’s Articles
• /articles: Post User’s Article
• /articles/{id}: Get Article By ID
• /articles/{id}: Delete Article by ID
• /articles/{id}/status: Update Article’s Status
• /articles/{id}/tags: Update Article’s Tags
• /tags: Get All Tags for a User

The following sections cover the details of the models of the Personal Reading List:

• User Model
• RegisterUserRequest Model
• LoginUserRequest Model
• Article Model
• ArticleSubmissionRequest Model
• UpdateArticleStatusRequest Model
• UpdateArticleTagRequest Model
• MessageResponse Model
• ErrorResponse Model