serverless-aws-documentation | Serverless 1.0 plugin | REST library

by deliveryhero JavaScript Version: v1.1.0 License: MIT

X-Ray Key Features Code Snippets Community Discussions(2)Vulnerabilities Install Support

kandi X-RAY | serverless-aws-documentation Summary

serverless-aws-documentation is a JavaScript library typically used in Web Services, REST, Fastapi applications. serverless-aws-documentation has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

Amazon introduced a new documentation feature for it's API Gateway on AWS at the end of 2016. With this you can add manually written documentation to all parts of API Gateway such as resources, requests, responses or single path or query parameters. When exporting Swagger from API Gateway these documentation is added to the other information to create a more human understandable documentation. In addition to this documentation this plugin also adds support to add models to API Gateway and use it with the serverless functions. Models are JSON Schemas that define the structure of request or response bodies. This includes property structure, their types and their validation. More about this you'll find here:

Support

Quality

Security

License

Reuse

Support

serverless-aws-documentation has a low active ecosystem.

It has 303 star(s) with 138 fork(s). There are 49 watchers for this library.

It had no major release in the last 12 months.

There are 55 open issues and 42 have been closed. On average issues are closed in 35 days. There are 17 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of serverless-aws-documentation is v1.1.0

Quality

serverless-aws-documentation has 0 bugs and 0 code smells.

Security

serverless-aws-documentation has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

serverless-aws-documentation code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

serverless-aws-documentation is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

serverless-aws-documentation releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

Top functions reviewed by kandi - BETA

kandi has reviewed serverless-aws-documentation and discovered the below as its top functions. This is intended to give you an instant insight into serverless-aws-documentation implemented functionality, and help decide if they suit your requirements.

Replace model
Replace references to REST endpoint
Extracts the model definition
Determines the properties of a type
Creates the output type of output file .
Determine the extension type .
Get the documentation properties from the docs object
Convert a map to object
Get the file extension .

Get all kandi verified functions for this library.

serverless-aws-documentation Key Features

No Key Features are available at this moment for serverless-aws-documentation.

serverless-aws-documentation Examples and Code Snippets

No Code Snippets are available at this moment for serverless-aws-documentation.

Community Discussions

Trending Discussions on serverless-aws-documentation

Serverless: How to integrate gateway response using serverless library?

serverless-aws-documentation model definitions with optional fields?

QUESTION

Serverless: How to integrate gateway response using serverless library?

Asked 2018-May-22 at 15:40

How to integrate gateway response using serverless framework?

I'm not able to find documentation in serverless.com as well as in plugin serverless-aws-documentation

...

ANSWER

Answered 2017-Jun-12 at 08:02

Good question. I believe you can do it in the s-function.json file like so:

Source https://stackoverflow.com/questions/44493807

QUESTION

serverless-aws-documentation model definitions with optional fields?

Asked 2017-Nov-23 at 23:08

I want to define request and response models. I use the Serverless Framework with AWS and everything I'm seeing recommends using serverless-aws-documentation

The README says that I need to have this line in custom.documentation.models.MODELNAME

...

ANSWER

Answered 2017-Nov-22 at 15:03

Just a guess (posting it as an answer to preserve formatting) - your top-level entity in the schema should be an object, not an array, something like this:

Source https://stackoverflow.com/questions/47301055

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install serverless-aws-documentation

This plugin only works for Serverless 1.0 and up. For a plugin that supports 0.5 look at this plugin.
To download the deployed documentation you just need to use serverless downloadDocumentation --outputFileName=filename.ext. For yml or yaml extensions application/yaml content will be downloaded from AWS. In any other case - application/json. Optional argument --extensions ['integrations', 'apigateway', 'authorizers', 'postman']. Defaults to 'integrations'.

Support

This is a Serverless v1 plugin that adds support for AWS API Gateway documentation and models (e.g. to export a Swagger JSON file with input/output definitions and full text documentation for API documentation).

Find more information at: