archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #5680 from sparkertime/patch-1

Browse Source 
Clarify docs for the http key for GCF
This commit is contained in:
Philipp Muens 2019-01-16 13:35:48 +01:00 committed by GitHub
commit ad5decb080
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/providers/google/events/http.md
View File

@ -22,7 +22,7 @@ It might be helpful to read the Google Cloud Functions [HTTP docs](https://cloud
### HTTP endpoint
This setup specifies that the `first` function should be run when someone accesses the Functions API endpoint via a `GET` request. You can get the URL for the endpoint by running the `serverless info` command after deploying your service.
This setup specifies that the `first` function should be run when someone accesses the Functions API endpoint. You can get the URL for the endpoint by running the `serverless info` command after deploying your service.
Here's an example:
@ -33,7 +33,7 @@ functions:
first:
handler: http
events:
- http: path
- http: foo # the value of this key is ignored. It is the presence of the http key that matters to serverless.
```
```javascript
@ -45,4 +45,11 @@ exports.first = (request, response) => {
};
```
### Differences from other providers
The configuration for Google Cloud Functions is a bit different than some other providers:
* Your deployed endpoint from above will accept GET, POST, and all other HTTP verbs. If you want to disallow certain verbs, [you can do that within the method body](https://cloud.google.com/functions/docs/writing/http#handling_http_methods).
* All Google Cloud Functions are deployed as just the handler name at the root of the URL pathname. In the example above, this means your function is deployed to `https://YOUR_URL/http`. As a result, you cannot configure nested routes such as `http/hello` in your `serverless.yml` file. Instead, Google passes all URLs that appear to be subdirectories of your URL to your handler function so that you can determine the appropriate behavior. The complete path is still available as `req.path` and can be parsed to provide nested routes, path/URL parameters, and more.
**Note:** See the documentation about the [function handlers](../guide/functions.md) to learn how your handler signature should look like to work with this type of event.