Skip to content

Commit

Permalink
made changes to the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
muthukumar89uk committed Jul 31, 2024
1 parent 0c1b48c commit c599614
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 6 deletions.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,50 @@
# go-restapi-beego
# Go REST API with Beego

This repository contains a RESTful API built using the Beego framework.

## Features

- CRUD operations
- RESTful API structure
- Postgresql database integration

## Requirements

- Go 1.15 or higher
- Go Beego Web Framework
- Postgresql

## Getting Started

### Installation

1. Clone the repository:

```
git clone https://github.com/muthukumar89uk/go-restapi-beego.git
```
Click here to directly [download it](https://github.com/muthukumar89uk/go-restapi-beego/zipball/master).

## Install dependencies:

go mod tidy

## Run the Application
1. Run the Server

```
go run .
```
2. The server will start on `http://localhost:9000`.

## API Endpoints

- `POST /v1/api/create/employee` - Create a new employee details
- `GET /v1/api/get/employees` - Retrieve all employees details
- `GET /v1/api/getById/:id` - Retrieve an employee details by ID
- `PUT /v1/api/updateById/:id` - Update an existing employee details
- `DELETE /v1/api/deleteById/:id` - Delete an employee details

## Refer
- [Beego Web Framework](https://github.com/beego/beego)
- [GORM](https://gorm.io/)
10 changes: 5 additions & 5 deletions routers/routers.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ import (
func Router(repo repository.RepoOperation) {
operation := handlers.HandlersInstance(repo)

beego.Post("/create/employee", operation.CreateEmployee)
beego.Get("/get/employee", operation.GetAllEmployee)
beego.Get("/getById/:id", operation.GetEmployeeById)
beego.Put("/updateById/:id", operation.UpdateEmployeeById)
beego.Delete("/deleteById/:id", operation.DeleteEmployeeById)
beego.Post("/v1/api/create/employee", operation.CreateEmployee)
beego.Get("/v1/api/get/employees", operation.GetAllEmployee)
beego.Get("/v1/api/getById/:id", operation.GetEmployeeById)
beego.Put("/v1/api/updateById/:id", operation.UpdateEmployeeById)
beego.Delete("/v1/api/deleteById/:id", operation.DeleteEmployeeById)

beego.Run(":9000")
}

0 comments on commit c599614

Please sign in to comment.