Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

868 improving README with AWS API gateway findings #869

Merged
merged 5 commits into from
Feb 18, 2019
Merged

868 improving README with AWS API gateway findings #869

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2218c3b
Merge pull request #1 from grpc-ecosystem/master
Feb 14, 2019
da80b49
868 improving README with AWS API gateway findings
Feb 14, 2019
e0148f3
868 adding review feedback
Feb 15, 2019
552a6c0
868 fixing typos related to aws documentation tips
Feb 16, 2019
ccda42b
Update docs/_docs/aws.md
johanbrandhorst Feb 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/_docs/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
category: documentation
---

# AWS

## Import swagger documentation into AWS API Gateway
The AWS API gateway service allows importing of a OpenAPI specification to create a REST API. The process is very straightforward and can be found [here](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).
fahernandez marked this conversation as resolved.
Show resolved Hide resolved
Here are some tips to consider when importing the documentation:

1. Remove any circular dependencies (these aren't supported by the parser).
2. Remove security-related annotations (These annotations aren't well supported by the parser).
3. Max length of fields are reviewed by the parser but the errors aren't self-explanatory. Review the [specification](https://swagger.io/specification/v2/) to verify that the requirements are met.
4. API gateway errors aren't great, but you can use this [page](https://apidevtools.org/swagger-parser/online/) for structure validation.
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ To learn more about us check out our documentation on:
* [Installation and usage](_docs/usage.md)
* [Examples](_docs/examples.md)
* [Features](_docs/features.md)
* [AWS API Gateway tips](_docs/aws.md)


# Contribution
Expand Down