azure-functions-university icon indicating copy to clipboard operation
azure-functions-university copied to clipboard

Content Request: Add video on VS Code REST Client

Open marcduiker opened this issue 4 years ago • 7 comments

📝 Lesson Description

Provide a clear and concise description of the content you'd like to have included.

This is not a full lesson on an Azure Functions topic but a short video on how to use the REST Client in VSCode when developing Azure Functions.

Are you authoring the lesson?

Indicate if you want to (help) write the lesson.

YES

👩‍🏫 If you are authoring then indicate if you want to join our live stream to help teach this lesson.

YES


Thanks! 😃 That's all we need to know for now. If you're interested in writing the lesson yourself please read the Process and Lesson Structure parts below so you're well prepared! 💪


Process

If you are contributing to create a lesson, please take into account the length and the tone of the existing lessons. We want to have a uniform experience across all of our lessons.

Once we've discussed this issue and agree to include the lesson you can submit a PR with the lesson and the source code. It will probably take a few iterations to get everything right, don't feel discouraged by this process ♥.

Lesson Structure

Please keep in mind the following structure of a lesson:

  • Give the lesson a short but descriptive title.
  • Describe the goal of the lesson.
  • Break up the lesson in small exercises.
  • Each exercise has a clear sub goal and steps how to achieve that sub goal.
  • Use code samples and plenty of 📝, 🔎 and ❔ call-outs.
  • Add a new project to the src folder with a completely worked out example.

marcduiker avatar Jan 12 '21 08:01 marcduiker

@marcduiker Just wondering if this lesson is just a demo for the VSCode extension for REST Client and how you can utilize it to make requests to Azure Functions?

rishabkumar7 avatar Jun 25 '21 19:06 rishabkumar7

@rishabkumar7 Yeah, I'm pretty sure that's correct.

madebygps avatar Jun 26 '21 14:06 madebygps

@rishabkumar7 yes correct! These tooling videos are meant to demonstrate the tool specifically in combination with Azure Functions. I see them as secondary content though. I find the lessons on the triggers & bindings (in all languages) a bit more important.

marcduiker avatar Jun 27 '21 20:06 marcduiker

@marcduiker For the lesson, should it be a video, and where does the code reside for the VSCode Rest Client demo?

rishabkumar7 avatar Nov 23 '21 18:11 rishabkumar7

Hi @rishabkumar7, there is no specific content for this lesson yet. I suggest to add:

  • a lesson\tooling\vscode-restclient folder with a markdown file with written instructions how the REST client can be used (see further down for the list with topics).
  • a tst\tooling\vscode-restclient folder with one or more .http files that contain the various REST code snippets to execute
  • The video (that we record together) will then go over the markdown lesson and demonstrate it all live.

This repo can be used to run a Function App locally and make calls to it: https://github.com/marcduiker/functionapp-deployment. If you feel that a separate solution is better suited to demonstrate the REST client than a new FunctionApp can be added to src/tooling/vscode-restclient.

I suggest the following should be present in the lesson:

  1. Why the REST Client is useful when working with HttpTriggered functions.
  2. How to install the REST Client
  3. How to do GET requests (incl query string)
  4. How to do POST requests with a JSON body
  5. Using file variables
  6. Using environment variables
  7. Using request variables
  8. Using system variables (guid, randomInt, datetime)

marcduiker avatar Nov 23 '21 19:11 marcduiker

@rishabkumar7 still interested in this one and would you be able to do this in Jan? If so, I'm happy to assign this to you.

If not, let me know and I'll pick this one up myself.

marcduiker avatar Dec 21 '21 19:12 marcduiker

@marcduiker yeah, I am interested in doing this one 👍🏽

rishabkumar7 avatar Dec 25 '21 03:12 rishabkumar7