Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harshit0571/coursemanagmentapi
https://github.com/harshit0571/coursemanagmentapi
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/harshit0571/coursemanagmentapi
- Owner: harshit0571
- Created: 2024-02-11T06:20:09.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T14:12:06.000Z (10 months ago)
- Last Synced: 2024-04-14T12:07:35.230Z (10 months ago)
- Language: JavaScript
- Homepage: https://course-managment-api.vercel.app
- Size: 118 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Endpoints
## Authentication
### Register a new user
- **Endpoint**: `/auth/register`
- **Method**: `POST`
- **Description**: Register a new user with the provided username and password.
- **Request Body**:
```json
{
"username": "example_user",
"name":"name_example",
"email":"example_email"
"password": "secretpassword"
}
```
### login a user
- **Endpoint**: `/auth/login`
- **Method**: `POST`
- **Description**: login user with the provided username and password.
- **Request Body**:
```json
{
"username": "example_user",
"password": "secretpassword"
}
```
## Courses
### Create a new course
- **Endpoint**: `/course`
- **Method**: `POST`
- **Description**: Create a new course with the provided details.
- **Request Body**:
```json
{
"title": "python",
"description": "python course for beginers",
"instructor": "Harshit Chadha",
"duration": 10
}
```
### Add modules and videos to the course
- **Endpoint**: `/course/:courseId/modules`
- **Method**: `POST`
- **Description**: Add a new module with the provided details.
- **Request Body**:
```json
{
"moduleTitle": "week 1",
"videosArray": [
{
"title": "data types",
"url": "https://www.youtube.com/watch?v=zOjov-2OZ0E&pp=ygUSY291cnNlIHByb2dyYW1taW5n"
},
{
"title": "arrays",
"url": "https://www.youtube.com/watch?v=zOjov-2OZ0E&pp=ygUSY291cnNlIHByb2dyYW1taW5n"
},
{
"title": "string",
"url": "https://www.youtube.com/watch?v=zOjov-2OZ0E&pp=ygUSY291cnNlIHByb2dyYW1taW5n"
},
{
"title": "objects",
"url": "https://www.youtube.com/watch?v=zOjov-2OZ0E&pp=ygUSY291cnNlIHByb2dyYW1taW5n"
}
]
}
```
### get all courses
- **Endpoint**: `/course`
- **Method**: `GET`
- **Description**: Get all courses.
### get specific course
- **Endpoint**: `/course/:courseId`
- **Method**: `GET`
- **Description**: Get specific course with course id.
## User
### get a user's details
- **Endpoint**: `/user/username`
- **Method**: `GET`
- **Description**: get user's details like name, email, and enrolled courses by sending username.
## Enroll
### Enroll in a course
- **Endpoint**: `/enroll/:courseId`
- **Method**: `POST`
- **Description**: Enroll in a course by sending courseID in params.