https://github.com/diglopes/conduit-api

https://github.com/diglopes/conduit-api

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/diglopes/conduit-api
• Owner: diglopes
• License: mit
• Created: 2020-06-03T09:48:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T02:49:20.000Z (almost 2 years ago)
• Last Synced: 2023-03-03T18:49:20.511Z (almost 2 years ago)
• Language: JavaScript
• Size: 2.58 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Conduit API

## Roadmap

### Endpoints

#### User

- [ ] **POST** /api/users - Registration route

- [ ] **POST** /api/users/login - Authentication route

- [ ] **GET** /api/user - Get current user (auth required)

- [ ] **PUT** /api/user - Update user data (auth required)

#### Profile

- [ ] **POST** /api/profiles/:username - Returns a profile (optional auth)

- [ ] **POST** /api/profiles/:username/follow - Follows an user (auth required)

- [ ] **DELETE** /api/profiles/:username/follow - Unfollows an user (auth required)

#### Article

- [ ] **GET** /api/articles - Returns most recent articles globally by default

  - [ ] Filters: tag, author and favorited

  - [ ] Limit (20 default) and offset (0 default)

- [ ] **GET** /api/articles/feed - Returns multiple articles created by followed users ordered by most recent first (auth required)

  - [ ] Limit (20 default) and offset (0 default)

- [ ] **GET** /api/articles/:slug - Returns a single article

- [ ] **POST** /api/articles - Creates a article (auth required)

- [ ] **PUT** /api/articles/:slug - Updates a article (auth required)

- [ ] **DELETE** /api/articles/:slug - Deletes a article (auth required)

- [ ] **POST** /api/articles/:slug/comments - Adds a comment (auth required)

- [ ] **GET** /api/articles/:slug/comments  - Gets comments from a article (auth optional)

- [ ] **DELETE** /api/articles/:slug/comments/:id - Deletes a comment from a article (auth required)

- [ ] **POST** /api/articles/:slug/favorite - Favorites a article (auth required)

- [ ] **DELETE** /api/articles/:slug/favorite - Unfavorites a article (auth required)

#### Tags

- [ ] **GET** /api/tags - Returns a list of tags