Documentation

Introduction

The CommunityAPI is built with node.js/express and TypeScript. This API is simple yet useful and a very much easy to use. With different route end points this API can handle all the CRUD operation related to a community mangement. This API returns a JSON object with all the details of courses like 'Course name','Price' and 'Url' as well.

😴 AS IT IS HOSTED IN A FREE CLOUD PLATFORM , THE FIRST REQUEST CAN TAKE TIME UPTO 20s TO RESPONSE AS THE SERVER GOES TO SLEEP AFTER 5 MIN OF INACTIVITY

📎 This is just an overview. Detailed Documentation can be found Here

Use Cases

There are many use cases are possible, such as

• Community Creation.
• Member Management.
• Role based access.

Endpoints

• Main URL ---> https://community-api-p49y.onrender.com/

• There are 4 main endpoints and various paths for each endpoints.

  User

  • There are 3 endpoints for user
  • Details about responses and parameters can be found 👉 Here

  POST https://community-api-p49y.onrender.com/v1/auth/sigunup

  POST https://community-api-p49y.onrender.com/v1/auth/signin

  GET https://community-api-p49y.onrender.com/v1/auth/me

  Role

  • There are 2 endpoints for role
  • Details about responses and parameters can be found 👉 Here

  POST https://community-api-p49y.onrender.com/v1/role

  GET https://community-api-p49y.onrender.com/v1/role?page=1&limit=10

  Member

  • There are 2 endpoints for role
  • Details about responses and parameters can be found 👉 Here

  POST https://community-api-p49y.onrender.com/v1/member

  DELETE https://community-api-p49y.onrender.com/v1/member/:id

  Community

  • There are 5 endpoints for role
  • Details about responses and parameters can be found 👉 Here

  POST https://community-api-p49y.onrender.com/v1/community

  GET https://community-api-p49y.onrender.com/v1/community?page=1&limit=10

  GET https://community-api-p49y.onrender.com/v1/community/7108143066959123096/members?page=1&limit=10

  POST https://community-api-p49y.onrender.com/v1/community/me/owner?page=1&limit=10

  POST https://community-api-p49y.onrender.com/v1/community/me/member?page=1&limit=10

Status Codes

FreecoursesAPI returns the following status codes in its API:

Status Code	Description
200	OK
400	BAD REQUEST
404	NOT FOUND
401	UNAUTHORIZED