Skip to content

Commit 5c11264

Browse files
authored
Merge pull request #210881 from ggailey777/sonia
Draft of APIM forward serverless API docs
2 parents 73d9271 + dfc98d8 commit 5c11264

File tree

5 files changed

+308
-239
lines changed

5 files changed

+308
-239
lines changed

articles/azure-functions/TOC.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@
248248
- name: Consumption plan costs
249249
href: functions-consumption-costs.md
250250
displayName: best practice
251-
- name: Functions Proxies
251+
- name: Serverless REST APIs
252252
href: functions-proxies.md
253253
- name: Networking options
254254
href: functions-networking-options.md
@@ -418,6 +418,8 @@
418418
href: functions-move-across-regions.md
419419
- name: Migrate to a zone-redundant plan
420420
href: ../availability-zones/migrate-functions.md?toc=%2fazure%2fazure-functions%2ftoc.json
421+
- name: Work with legacy Functions Proxies
422+
href: legacy-proxies.md
421423
- name: Monitor
422424
items:
423425
- name: Monitor function apps with Azure Monitor
@@ -529,7 +531,7 @@
529531
displayName: OpenAPI, Swagger
530532
- name: Use a managed identity
531533
href: ../app-service/overview-managed-identity.md?toc=/azure/azure-functions/toc.json
532-
- name: Customize HTTP function endpoint
534+
- name: Customize endpoints with legacy proxies
533535
href: functions-create-serverless-api.md
534536
- name: Manage on-premises resources
535537
href: functions-hybrid-powershell.md

articles/azure-functions/functions-create-serverless-api.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ ms.custom: mvc
1010

1111
# Customize an HTTP endpoint in Azure Functions
1212

13-
In this article, you learn how Azure Functions allows you to build highly scalable APIs. Azure Functions comes with a collection of built-in HTTP triggers and bindings, which make it easy to author an endpoint in a variety of languages, including Node.js, C#, and more. In this article, you'll customize an HTTP trigger to handle specific actions in your API design. You'll also prepare for growing your API by integrating it with Azure Functions Proxies and setting up mock APIs. These tasks are accomplished on top of the Functions serverless compute environment, so you don't have to worry about scaling resources - you can just focus on your API logic.
13+
In this article, you learn how Azure Functions allows you to build highly scalable APIs. Azure Functions comes with a collection of built-in HTTP triggers and bindings, which make it easy to author an endpoint in various languages, including Node.js, C#, and more. In this article, you'll customize an HTTP trigger to handle specific actions in your API design. You'll also prepare for growing your API by integrating it with Azure Functions Proxies and setting up mock APIs. These tasks are accomplished on top of the Functions serverless compute environment, so you don't have to worry about scaling resources - you can just focus on your API logic.
14+
15+
[!INCLUDE [functions-legacy-proxies-deprecation](../../includes/functions-legacy-proxies-deprecation.md)]
1416

1517
## Prerequisites
1618

@@ -84,7 +86,7 @@ In this section, you create a new proxy, which serves as a frontend to your over
8486

8587
### Setting up the frontend environment
8688

87-
Repeat the steps to [Create a function app](./functions-get-started.md) to create a new function app in which you will create your proxy. This new app's URL serves as the frontend for our API, and the function app you were previously editing serves as a backend.
89+
Repeat the steps to [Create a function app](./functions-get-started.md) to create a new function app in which you'll create your proxy. This new app's URL serves as the frontend for our API, and the function app you were previously editing serves as a backend.
8890

8991
1. Navigate to your new frontend function app in the portal.
9092
1. Select **Configuration** and choose **Application Settings**.
@@ -126,7 +128,7 @@ Next, you'll use a proxy to create a mock API for your solution. This proxy allo
126128

127129
To create this mock API, we'll create a new proxy, this time using the [App Service Editor](https://github.com/projectkudu/kudu/wiki/App-Service-Editor). To get started, navigate to your function app in the portal. Select **Platform features**, and under **Development Tools** find **App Service Editor**. The App Service Editor opens in a new tab.
128130

129-
Select `proxies.json` in the left navigation. This file stores the configuration for all of your proxies. If you use one of the [Functions deployment methods](./functions-continuous-deployment.md), you maintain this file in source control. To learn more about this file, see [Proxies advanced configuration](./functions-proxies.md#advanced-configuration).
131+
Select `proxies.json` in the left navigation. This file stores the configuration for all of your proxies. If you use one of the [Functions deployment methods](./functions-continuous-deployment.md), you maintain this file in source control. To learn more about this file, see [Proxies advanced configuration](./legacy-proxies.md#advanced-configuration).
130132

131133
If you've followed along so far, your proxies.json should look like as follows:
132134

@@ -180,7 +182,7 @@ Next, you'll add your mock API. Replace your proxies.json file with the followin
180182
}
181183
```
182184

183-
This code adds a new proxy, `GetUserByName`, without the `backendUri` property. Instead of calling another resource, it modifies the default response from Proxies using a response override. Request and response overrides can also be used in conjunction with a backend URL. This technique is particularly useful when proxying to a legacy system, where you might need to modify headers, query parameters, and so on. To learn more about request and response overrides, see [Modifying requests and responses in Proxies](./functions-proxies.md).
185+
This code adds a new proxy, `GetUserByName`, without the `backendUri` property. Instead of calling another resource, it modifies the default response from Proxies using a response override. Request and response overrides can also be used with a backend URL. This technique is useful when proxying to a legacy system, where you might need to modify headers, query parameters, and so on. To learn more about request and response overrides, see [Modifying requests and responses in Proxies](./legacy-proxies.md).
184186

185187
Test your mock API by calling the `<YourProxyApp>.azurewebsites.net/api/users/{username}` endpoint using a browser or your favorite REST client. Be sure to replace _{username}_ with a string value representing a username.
186188

@@ -196,4 +198,4 @@ The following references may be helpful as you develop your API further:
196198

197199

198200
[Create your first function]: ./functions-get-started.md
199-
[Working with Azure Functions Proxies]: ./functions-proxies.md
201+
[Working with Azure Functions Proxies]: ./legacy-proxies.md

0 commit comments

Comments
 (0)