-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0c1b48c
commit c599614
Showing
2 changed files
with
55 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters