loopback-next icon indicating copy to clipboard operation
loopback-next copied to clipboard

Add POST example to Calling REST APIs

Open mrmodise opened this issue 4 years ago • 9 comments

The Calling REST APIs section demonstrates how to use LoopBack 4 to call GET APIs. It would be benefiting to the broader community to demonstrate how to call POST APIs. I have the todo-jwt example hosted in Heroku that could be used in the documentation to help illustrate the practical aspects of the topic. Feel free to use any open source POST API or placeholders to demonstrate the idea

Acceptance criteria

  • [ ] Split the page into 2 sections; a) calling GET APIs and b) calling POST APIs
  • [ ] Include step by step instructions of how to set up the 2 types of API calls
  • [ ] Provide evidence of what the success or failure result would look like
  • [ ] Include Common Task section that links out to further readings on the topics discussed such as datasources, controllers, services and models

mrmodise avatar Sep 28 '21 20:09 mrmodise

Can I work on this change?

Ashwithabg avatar Oct 04 '21 06:10 Ashwithabg

Thanks for your interest. Please go ahead @Ashwithabg

mrmodise avatar Oct 05 '21 05:10 mrmodise

Hello, do you still need help on this issue? I'm learning how to document REST APIs and would love to use this as a learning experience.

ghanvik avatar Oct 21 '21 22:10 ghanvik

@Ashwithabg, if I'm not mistaken, I do not see PRs related to this. I'm wondering if you're still on it? Thanks.

dhmlau avatar Oct 22 '21 14:10 dhmlau

@dhmlau can I pick this up?

neel-desh avatar May 31 '22 10:05 neel-desh

@dhmlau can I pick this up?

Hi. Feel free there has not been a PR on this

mrmodise avatar May 31 '22 12:05 mrmodise

@mrmodise I have few question, so i have to edit this page, the tasks as you mentioned is to split pages into 2 sections, Usage of GET and POST with LoopBack 4. And you have already written how to use loopback to create GET api here.

So my question is, should I extend what you have written to explain POST request or I should write both from scratch? and should the example include how authentication works or I can discard it?

neel-desh avatar Jun 01 '22 14:06 neel-desh

@neel-desh, i think it would be good to edit this page to include the POST scenario as well. Feel free to add any information on how to get authentication works in that docs as well. We have a list of examples created by the community. If you think it would be useful to put it there, please add it to https://loopback.io/doc/en/lb4/Community-examples.html as well.

dhmlau avatar Jun 02 '22 16:06 dhmlau

I might not be able to pick this. sorry. Someone else could go ahead and pick this up.

neel-desh avatar Jun 03 '22 14:06 neel-desh

Can i pick this up?

BharathA14 avatar May 12 '23 08:05 BharathA14