andrewcurioso / raml-serverless Goto Github PK
View Code? Open in Web Editor NEWWork with RAML documentation for Serverless v1.0 projects
Home Page: https://www.npmjs.com/package/raml-serverless
License: MIT License
Work with RAML documentation for Serverless v1.0 projects
Home Page: https://www.npmjs.com/package/raml-serverless
License: MIT License
Hi. This seems to look like a very cool project. Are you still working on it?
Automatically add the API key header (x-api-key
) to private methods.
Documentation: https://serverless.com/framework/docs/providers/aws/events/apigateway#setting-api-keys-for-your-rest-api
If a RAML property cannot be understood it should be put under custom so that if a RAML file is generated from the serverless.yml
file later, it will have the same properties.
Example:
custom:
documentation:
raml:
title: My Awesome API
Automatically add headers and response codes for methods with direct Lambda integrations.
Getting the following error:
$ sls raml
Type Error ---------------------------------------------
Cannot read property 'split' of undefined
Reproduce:
npm install --save raml-serverless
$ git diff serverless.yml
plugins:
- serverless-python-requirements
+ - raml-serverless
sls raml > docs.raml
Node version: v6.10.1
Serverless version 1.18.0
Take a RAML file as input and generate a Serverless HTTP events for every endpoint in the RAML. For now they can all be under a single function and the user can split it up as necessary.
This includes putting all properties that don't directly translate into Serverless under the documentation: raml:
section of the HTTP event.
RAML has a mechanism to document URI parameters for a call. I can not figure out how to put this documentation into the server.yml file in such a way that it will show up in the correct spot in the output RAML file. Am I missing something, or does raml-serverless not yet support this?
In the RAML file, the uriParameters:
tag should be between the path and the HTTP action. However, by the time we are specifying the "documentation:\n raml:" tag in our server.yml file, we are already specifying information related to the method itself.
If raml-serverless can't do this then please consider this a feature request.
If the function has cors
configured on it, the documentation should contain the appropriate headers.
Write unit tests.
Populate baseUri
automatically with the root endpoint of the API gateway deployment.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.