https://github.com/ar90n/serverless-plugin-export-endpoints

Export lambda endpoints as json
https://github.com/ar90n/serverless-plugin-export-endpoints

api aws endpoints my-projects serverless

Last synced: about 1 month ago
JSON representation

Export lambda endpoints as json

• Host: GitHub
• URL: https://github.com/ar90n/serverless-plugin-export-endpoints
• Owner: ar90n
• License: mit
• Created: 2017-05-12T00:55:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-28T23:21:05.000Z (over 4 years ago)
• Last Synced: 2025-10-13T12:00:07.940Z (6 months ago)
• Topics: api, aws, endpoints, my-projects, serverless
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
serverless-plugin-export-endpoints

===============

Export API Gateway endpoints as json

serverless-plugin-export-endpoints is a Serverless plugin to export API Gateway endpoints as json.

Installation

===============

    npm install serverless-plugin-export-endpoints --save-dev

Example

===============

    $cd example

    $sls deploy

    $sls exportEndpoints

    $cat endpoints.json

    {

      "hello": {

      "GET": "https://your-api-gateway-endpoint.execute-api.us-east-1.amazonaws.com/dev/hello"

    }

    $node test.js

    Go Serverless v1.0! Your function executed successfully!

Configuration

===============

    custom:

        exportEndpoints:

            path: "./endpoints.json" # optional

            serviceEndpointKey: "/^ServiceEndpoint/" # optional, regex or string

Note: serviceEndpointKey is by default provided by the Serverless AWS provider https://github.com/serverless/serverless/blob/master/lib/plugins/aws/lib/naming.js

License

===============

This software is released under the MIT License, see LICENSE.txt.