Giter Club home page Giter Club logo

course-manager-api's Introduction

Course Manager REST API ASP .NET Core 5

C# .Net

Course Logo Professor Logo

๐Ÿ’ป Prerequisites

Before you begin, make sure you meet the following requirements:

๐Ÿš€ Running the Course Manager project

Inside the Gerenciador_de_cursos project folder, follow these steps:

CLI (Windows / Linux):

dotnet restore
dotnet build
dotnet run

Access the link at: https://localhost:50001/api or http://localhost:5000/api

โฌ†๏ธ Requests and Responses โฌ‡๏ธ [User]

API Description Request Response Body
GET /api/users/index Returns all users None Array of User
GET /api/users/show/{id} Returns a user via id Guid item JSON of type User
POST /api/users/create Adds a new user UserCreateDTO item JSON of type User
PUT /api/users/update/{id} Updates a user via id UserUpdateDTO item JSON of type User
DELETE /api/users/delete/{id} Deletes a user via id Guid item JSON of type DeleteResponseDTO

โฌ†๏ธ Requests and Responses โฌ‡๏ธ [Course]

API Description Request Response Body
GET /api/courses/index Returns all courses None Array of CourseResponseDTO
GET /api/courses/show/{id} Returns a course via Id Guid item JSON of type CourseResponseDTO
POST /api/courses/create Adds a new course CourseCreateDTO item JSON of type CourseResponseDTO
PUT /api/courses/update/date/{id} Updates the dates of a course via id CourseUpdateDTO item JSON of type CourseResponseDTO
PATCH /api/courses/update/status/{id} Updates the status of a course via id StatusCourseEnum item JSON of type CourseResponseDTO
PATCH /api/courses/update/title/{id} Updates the title of a course via id Guid item JSON of type CourseResponseDTO
DELETE /api/courses/delete/{id} Deletes a course via id Guid item JSON of type DeleteResponseDTO

Tables Diagram

Diagrama

Status Codes used in the project

StatusCode Description
200 ๐ŸŸข Sucess
201 ๐ŸŸข Created
400 ๐ŸŸก Bad Request
401 ๐ŸŸก Unauthorized
403 ๐ŸŸก Forbidden
404 ๐ŸŸก Not Found
500 ๐Ÿ”ด Internal Server Error

โœ๏ธ Author

Made by me, with love โค๏ธ :)

Leo
Leonardo Oliveira

๐Ÿ“ License

This project is under a license. See the MIT file for more details. MIT

course-manager-api's People

Contributors

leozartino avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.