Skip to content

About

This repository contains the back-end code for managing database access to certain aspects of a User Profile.

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

user-profile-api

Overview

This repository contains the necessary files to host restful API's using Protocol Buffers (a.k.a protobuf) under golang to run a database. Information on protocol buffers can be found on protobufs Google Developers site. All of the endpoints are hosted using Heroku. The database was implemented using MongoDB with the help of the public MongoDB driver mgo and is being hosted using mLab. This repository handles requests from multiple pages of our website dealing with user profile information.

Program Execution

Make sure mgo, glog, grpc-gateway, cors, and grpc are installed in your golang environment. To execute the program run the server.go file as follows,

go run server.go

This will execute the server file.

Endpoints

Each endpoint expects to receive specific fields to process a request. The following are the expectations for each endpoint and the response. The API link is https://tea-user-profile-api.herokuapp.com/. Note that each endpoint only accepts POST requests, so the link will only display a "Not Found" message since GET requests aren't supported.

Endpoint Request Response
getuserprofile string email = 1; string profileimage = 1;
string profiledescription = 2;
repeated string endorsements = 3;
repeated string currentprojects = 4;
repeated string previousprojects = 5;
updateuserprofile string email = 1;
string profileimage = 2;
string profiledescription = 3;
repeated string currentprojects = 4;
repeated string previousprojects = 5;
bool success = 1;

About

This repository contains the back-end code for managing database access to certain aspects of a User Profile.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

⌂ 换网址