https://github.com/nitinn77/instagram-backendapi

A Golang REST API to handle users and posts for a simple instagram backend. Uses MongoDB as the database. Tested using golang-testing and Postman.
https://github.com/nitinn77/instagram-backendapi

golang mongodb rest-api

Last synced: about 1 month ago
JSON representation

A Golang REST API to handle users and posts for a simple instagram backend. Uses MongoDB as the database. Tested using golang-testing and Postman.

• Host: GitHub
• URL: https://github.com/nitinn77/instagram-backendapi
• Owner: NitinN77
• License: mit
• Created: 2021-10-09T10:32:38.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-10T03:01:30.000Z (over 4 years ago)
• Last Synced: 2025-03-01T14:17:41.732Z (over 1 year ago)
• Topics: golang, mongodb, rest-api
• Language: Go
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Instagram-BackendAPI

A Golang REST API to handle users and posts for a simple instagram backend. Uses MongoDB as the database. Tested using golang-testing and Postman.

## External Dependencies

- mongo-driver 

- godotenv (to handle secrets using environment variables, not required)

## Directory Structure

```

├── go.mod

├── go.sum

├── helper

│   └── connect.go

├── main.go

├── main_test.go

└── models

    └── models.go

```

- ``` go.mod, go.sum ``` Manages dependencies

- ``` connect.go ``` Establishes a connection to the MongoDB clusters

- ``` models.go ``` Defines the model objects

- ``` main.go ``` Primary file to handle http requests 

- ``` main_test.go ``` Unit testing script 

## Endpoints

#### ``` /api/posts ``` 

creates a post using data from the POST request's body

#### ``` /api/posts/ ``` 

fetches post details for the given id

#### ``` /api/posts/users/?limit={}&lastid={} ``` 

fetches posts of the user with given id within a limit and with ids greater than lastid (if lastid is not null)

#### ``` /api/users ```

creates a user and encrypts the password using ciphers before storing

#### ``` /api/users/ ``` 

fetches user details of given id

## Pagination

The API employs an id-based pagination for the  ``` /api/posts/users/ ``` endpoint. 

On the initial call, the limit parameter must be passed along with the request. The API returns the requsted number of posts and the id of the last post. Subsequent calls 

from the front-end must also contain a ``` lastid ``` parameter with the id that was returned on the previous call. This ensures that the second call returns posts starting 

with ids greater than the ``` lastid ``` , and that the API response doesn't explode in size.

![](https://i.imgur.com/DOhl8Pc.png)

## Testing

![](https://i.imgur.com/vv4nVgj.png)

## Usage

1. clone the repo ``` git clone https://github.com/VoidlessVoid7/Instagram-BackendAPI . ```

2. ``` go build main.go ```

3. ``` go run ./ ```

## Screenshots

- Creating a post

![](https://i.imgur.com/3X7lqst.png)

- Fetching a post

![](https://i.imgur.com/n6H3WjF.png)

- Create a user

![](https://i.imgur.com/f1EPfqO.png)

- Fetch a user

![](https://i.imgur.com/GlOGzhu.png)

- Fetch posts created by a user

![](https://i.imgur.com/SKz48ya.png)