search

bruno-chavez / restedancestor

restedancestor is a pretty simple REST API, responds with quotes from Darkest Dungeon.
MIT License
6 stars 8 forks source link

New Routes #1

Open bruno-chavez opened 6 years ago

bruno-chavez commented 6 years ago

Hey there! I made this mainly to have fun with REST APIs so if anyone is interested in adding more routes, feel free to do so! great opportunity to introduce yourself with APIs and networking.

WheeskyJack commented 6 years ago

Hi, I am interested in contributing to the project..

Can we have cli interface to this server app? Like instead of opening browser, we can make request via cli... sort of merge of the ancestorquotes cli to this one ..or may be entirely new cli?

BR.

bruno-chavez commented 6 years ago

Hi and thanks for taking interest, even though designing an CLI tool for consuming APIs is something that i would like to do in the near future it goes out of the scope of restedancestor, since using the browser to do this task is pretty basic at best, i would update the README with more ways to interact with the API.

You can check Postman if you like, its a pretty powerful tool to interact with APIs.

WheeskyJack commented 6 years ago

cool :) ; so, will the cli be new feature to this repo or will it be new project itself? I am asking because I am interested in working on that part...

bruno-chavez commented 6 years ago

A separate project of its own since its completely different to just adding it as a feature to restedancestor, you can check HTTPie as a goal of what could be achieved with a tool like that.

Tapudp commented 6 years ago

Man I wish you would have made this in JavaScript with Express.js/Node.js something.

bruno-chavez commented 6 years ago

Hey @Tapudp take this chance to learn Go! its a great language with some awesome features in it, and the transition from Express and Node is quite smooth, don't get stuck with just MEAN!

Tapudp commented 6 years ago

@bruno-chavez Okay sure, I just looked at how to write routes with GoLang, can you please explain more on that? I really want to start with making routes I really like to create those and play around. and this would be my first open source contribution per say. so any help/guidance is so much appreciated. I hope I'm not sounding boring.

bruno-chavez commented 6 years ago

For sure! take a loot at main.go that is were all the routes are defined simply follow the pattern of the ones already in there to create a new one, the most important thing is defining what methods a route is going to accept and the handler or controller that will handle that route, which you implement in handler.go (think of Controllers in a MVC pattern) again just look at how others handlers are implemented in the file for a quick reference, keep in mind that both requests and responses are in a JSON format,and that's pretty much it, for a more in-depth explanation check online resources for REST API's in Go, feel free to ask here if you need any help.

Tapudp commented 6 years ago

Okay so I have been looking at it and have been practicing I have some issues with Packages not being found, like in my main app.go file it wasn't able to find the package main, I have installed the GO nicely as stated on the golang docs

Also looked at a tutorial on RESTful API in Go on Hackernoon's medium page. I think I would be able to write new routes just need some help with this small tid-bits.

Tapudp commented 6 years ago

@bruno-chavez Hey you there? Kinda stuck with those packages not being able to found? I am eager to complete this though. Thanks

bruno-chavez commented 6 years ago

Hey @Tapudp do you mind opening a new issue since your problems are not related to routing, and please add more details so i can help you out.

Tapudp commented 6 years ago

@bruno-chavez I hope this is still open to add, I'm really sorry I have been giving interview this week, I hope I can work on this and will be able to contribute to this.

bruno-chavez commented 6 years ago

The issue is still open so yea, I'm still looking to add more routes!

aneesh1992 commented 6 years ago

I have submitted a pull request.

hazzabee commented 5 years ago

Hi, I've been teaching myself REST API documentation the last 3 months so if anyone wants endpoints documenting, I'd be happy to contribute.

bruno-chavez commented 5 years ago

The project may be a bit to little, but if you want, feel free to take a look and maybe even write some awesome docs!

saurabh98s commented 5 years ago

Hey, I have just started working on contributions, I am familiar with GoLang and have created few API endpoints, I would feel happy to contribute on the product adding more routes or anything I can help with.

bruno-chavez commented 5 years ago

Sure thing! just come up with some new routes, make a PR and I'll review it and give feedback if needed.

yogisinha commented 5 years ago

Hi, I want to contribute something to this project. Let me know how I can help. I know Go.

Artem-ka-create commented 1 year ago

Hey there! I made this mainly to have fun with REST APIs so if anyone is interested in adding more routes, feel free to do so! great opportunity to introduce yourself with APIs and networking.

Hi , is it currently actual to add more routes. Im interested in solving this issue