Python HTTPTrigger Lesson

.tours/python/http/.tours/01creating-a-function-app.tour

@@ -0,0 +1,201 @@
+{
+  "$schema": "https://aka.ms/codetour-schema",
+  "title": "Python HTTP - 01. Creating a Function App",
+  "steps": [
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 17,
+          "character": 28
+        }
+      },
+      "description": "The `__init__.py` file is a Python file containing the code of your function exported as an Azure Function.",
+      "title": "Walk through Azure Function file structure - __init__.py (1)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 6,
+          "character": 1
+        },
+        "end": {
+          "line": 6,
+          "character": 86
+        }
+      },
+      "description": "As we use the HTTP triggered Azure Function template, we receive the HTTP request as input to our function.",
+      "title": "Walk through Azure Function file structure - __init__.py (2)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 9,
+          "character": 1
+        },
+        "end": {
+          "line": 16,
+          "character": 66
+        }
+      },
+      "description": "These lines of code shows us how to extract information from the request object. We can fetch data from the query parameters (`req.params`) or the body of the request (`req_body`).",
+      "title": "Walk through Azure Function file structure - __init__.py (3)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 18,
+          "character": 1
+        },
+        "end": {
+          "line": 23,
+          "character": 149
+        }
+      },
+      "description": "Next we define our response text depending on the existence of the `name` property handed over to the function via a query parameter or in the body of the HTTP request.",
+      "title": "Walk through Azure Function file structure - __init__.py (4)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 22,
+          "character": 1
+        },
+        "end": {
+          "line": 23,
+          "character": 50
+        }
+      },
+      "description": "We return a result message and a response status. The response status is defaulted with 200. ",
+      "title": "Walk through Azure Function file structure - __init__.py (5 )"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 20,
+          "character": 2
+        }
+      },
+      "description": "The `function.json` file contains the [function specific configuration](https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference?tabs=blob).",
+      "title": "Walk through Azure Function file structure - function.json"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 5,
+          "character": 7
+        },
+        "end": {
+          "line": 5,
+          "character": 31
+        }
+      },
+      "description": "The attribute `authLevel`contains the authorization level for our function.",
+      "title": "Walk through Azure Function file structure - function.json (authorization level)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 6,
+          "character": 7
+        },
+        "end": {
+          "line": 8,
+          "character": 21
+        }
+      },
+      "description": "In addition we define the input bindings i.e. the information that is passed into our function. We define the name that we can use to access the binding in our function code. Here we use the name `req`. \r\nThe trigger binding is a special type of input binding for a function as it is the one that represents the trigger for the function execution. You can only have one trigger binding per function but multiple other input bindings. ",
+      "title": "Walk through Azure Function file structure - function.json (trigger and input binding)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 9,
+          "character": 6
+        },
+        "end": {
+          "line": 12,
+          "character": 8
+        }
+      },
+      "description": "The attribute `methods` contains an array of the HTTP verbs that the user can use to invoke your function via an HTTP request.",
+      "title": "Walk through Azure Function file structure - function.json (HTTP methods)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 14,
+          "character": 5
+        },
+        "end": {
+          "line": 18,
+          "character": 6
+        }
+      },
+      "description": "As counterpart of the input binding we also define an output binding for our function. This binding represents the data that is returned from our function after execution. In our scenario we have the type of `http` as output binding which means that we return an HTTP response.",
+      "title": "Walk through Azure Function file structure - function.json (output binding)"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/host.json",
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 16,
+          "character": 1
+        }
+      },
+      "description": "The `host.json` file [global configuration options](https://docs.microsoft.com/en-us/azure/azure-functions/functions-host-json) for all functions in a function app.",
+      "title": "Walk through Azure Function file structure - host.json"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/local.settings.json",
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 8,
+          "character": 1
+        }
+      },
+      "description": "The `local.settings.json` file contains the [app settings and connection strings](https://docs.microsoft.com/en-us/azure/azure-functions/functions-host-json) for local development. Make sure that the file is excluded in your `.gitignore` file. For the sake of this lesson we have excluded this file from `.gitignore`.",
+      "title": "Walk through Azure Function file structure - local.settings.json "
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/01CreatingAFunctionApp/requirements.txt",
+      "selection": {
+        "start": {
+          "line": 1,
+          "character": 1
+        },
+        "end": {
+          "line": 6,
+          "character": 71
+        }
+      },
+      "description": "Before we can execute the function we first must install the dependencies via `pip install -r requirements.txt`",
+      "title": "Install Python dependencies"
+    }
+  ]
+}

.tours/python/http/.tours/02changing-the-template-for-get-requeststour.tour

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://aka.ms/codetour-schema",
+  "title": "Python HTTP - 02. Changing the template for GET requests",
+  "steps": [
+    {
+      "file": "../../../src/python/AzureFunctions.Http/02ChangingTheTemplateForGetRequest/HelloWorldHttpTrigger/function.json",
+      "description": "Remove the `post` entry from the `methods`array in the `function.json` file. Now the function can only be triggered by a GET request.",
+      "line": 10,
+      "title": "Restrict the function endpoint to HTTP GET"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/02ChangingTheTemplateForGetRequest/HelloWorldHttpTrigger/__init__.py",
+      "description": "We leave the `req` parameter associated with the `GET` request unchanged. However, we will removed the `body` parameter associated with the `POST` request.",
+      "line": 9,
+      "title": "Fetch query parameter from HTTP request"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/02ChangingTheTemplateForGetRequest/HelloWorldHttpTrigger/__init__.py",
+      "description": "We define a variable for the response code.",
+      "line": 14,
+      "title": "Define variable for the HTTP response code"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/02ChangingTheTemplateForGetRequest/HelloWorldHttpTrigger/__init__.py",
+      "description": "Add an `if` statement to the function that checks if the name value is `null`, an empty string or `undefined`. If this is this case we return an HTTP code 400 as response, otherwise we return an HTTP code 200. Now the function has proper return values for both correct and incorrect invocations.",
+      "line": 11,
+      "selection": {
+        "start": {
+          "line": 12,
+          "character": 1
+        },
+        "end": {
+          "line": 13,
+          "character": 1
+        }
+      },
+      "title": "Implement the logic for the response"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/02ChangingTheTemplateForGetRequest/HelloWorldHttpTrigger/__init__.py",
+      "description": "Run the function via `func host start`. Invoke it once without name value in the query string: [http://localhost:7071/api/HelloWorldHttpTrigger](http://localhost:7071/api/HelloWorldHttpTrigger) and once with a name value: [http://localhost:7071/api/HelloWorldHttpTrigger?name=AzureFunctionsUniversity](http://localhost:7071/api/HelloWorldHttpTrigger?name=AzureFunctionsUniversity)",
+      "line": 21,
+      "title": "Run and call the function"
+    }
+  ]
+}

.tours/python/http/.tours/03changing-the-template-for-post-requeststour.tour

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://aka.ms/codetour-schema",
+  "title": "Python HTTP - 03. Changing the template for POST requests",
+  "steps": [
+    {
+      "file": "../../../src/python/AzureFunctions.Http/03ChangingTheTemplateForPostRequests/HelloWorldHttpTrigger/function.json",
+      "selection": {
+        "start": {
+          "line": 8,
+          "character": 1
+        },
+        "end": {
+          "line": 12,
+          "character": 8
+        }
+      },
+      "description": "Let's change the function to also allow POST requests and test it by posting a request with JSON content in the body.  Add the `post` entry in the `methods`array in the `function.json` file.",
+      "title": "Change function.json to enable HTTP POST requests"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/03ChangingTheTemplateForPostRequests/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 10,
+          "character": 5
+        },
+        "end": {
+          "line": 10,
+          "character": 32
+        }
+      },
+      "description": "The function in the `__init__.py` file currently only handles GET requests. We need to add some logic to use the query string for GET and the request body for POST requests. This can be done by checking the method property of the request parameter.",
+      "title": "Implement distinction between GET and POST requests"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/03ChangingTheTemplateForPostRequests/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 27,
+          "character": 9
+        },
+        "end": {
+          "line": 28,
+          "character": 158
+        }
+      },
+      "description": "We return a message in case of an invalid request to handle the two different error situations for GET and POST.",
+      "title": "Adopt error message"
+    },
+    {
+      "file": "../../../src/python/AzureFunctions.Http/03ChangingTheTemplateForPostRequests/HelloWorldHttpTrigger/__init__.py",
+      "selection": {
+        "start": {
+          "line": 30,
+          "character": 1
+        },
+        "end": {
+          "line": 30,
+          "character": 27
+        }
+      },
+      "description": "Now we can run the function via `func host start`. To trigger the logic we send a POST request to the endpoint. If you're using the [VSCode REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) you can use this in a .http file:\r\n\r\n```http\r\nPOST http://localhost:7071/api/HelloWorldHttpTrigger\r\nContent-Type: application/json\r\n\r\n{\r\n    \"name\": \"Your name\"\r\n}\r\n```",
+      "title": "Run and call the function"
+    }
+  ]
+}