Code Monkey home page Code Monkey logo

restapi-university's Introduction

University REST API

This is a RESTful API for managing student, teacher, grade, and course data for a university.

Technologies Used

  • .NET Core
  • ASP.NET Core Web API
  • Entity Framework Core
  • MYSQL Server
  • JWT or Oauth authorization
  • React (optional, if you're building a React frontend)

Getting Started

To get started with the University API, follow these steps:

  1. Clone the repository:

    git clone [email protected]:Nix-code/University.Catalog.RestAPI.git
    
  2. Install the required dependencies:

    dotnet restore
    
  3. Configure the database connection in appsettings.json or appsettings.Development.json

  4. Run the API:

    dotnet run
    
  5. The API will start running on https://localhost:port

API Endpoints

The University API provides the following endpoints for accessing student's detail:

  • GET /api/students: Get all students

  • GET /api/students/{id}: Get a specific student by ID

  • POST /api/students: Create a new student

  • PUT /api/students/{id}: Update an existing student

  • DELETE /api/students/{id}: Delete a student

Similar endpoints are available for teachers, grades, and courses

Directory Tree

└── University
    ├── BusinessLogic
    │   └── ModelsDtos
    │       └── Student.Model.Dto
    │           ├── CreateStudentRecordDto.cs
    │           ├── StudentEntityDto.cs
    │           └── UpdateStudentRecordDto.cs
    ├── DataAccess
    │   ├── Entities
    │   │   ├── Course.Entity
    │   │   │   └── CourseEntity.cs
    │   │   ├── Grade.Entity
    │   │   │   └── GradeEntity.cs
    │   │   ├── Student.Entity
    │   │   │   └── StudentEntity.cs
    │   │   └── Teacher.Entity
    │   │       └── TeacherEntity.cs
    │   └── Persistence
    │       └── StudentPersistence
    │           ├── DbContext.cs
    │           └── Repositories
    │               ├── IStudentRepository.cs
    │               └── StudentRepository.cs
    ├── Helper
    │   └── StudentHelper.cs
    └── Presentation
        └── Controllers
            ├── Course.Controller
            │   └── CourseController.cs
            ├── Grade.Controller
            │   └── GradeController.cs
            ├── Student.Controller
            │   └── StudentController.cs
            └── Teacher.Controller
                └── TeacherController.cs

Demo

GET Request Demo

Contributing

Contributions are welcome! If you have any suggestions, bug reports, unit tests or feature requests, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

restapi-university's People

Contributors

nixhantb avatar

Watchers

 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.