RFC: Update Docs for REST API and DynamoDB Storage

Pages: CLI -> API (Rest) and Libraries -> API (Rest)

Feedback:

Currently the Amplify Framework documentation tends to favor GraphQL over REST API implementations in terms of content available. It would be nice if there was more documentation on how to setup various REST API’s so that customer’s could choose whatever fits best for their use case.

Solution

I’m proposing new content be added to show varying CLI paths, recipes for usage, and general authorization practices. This would be for both API in terms of API Gateway + Lambda as well as API Gateway + Lambda + DynamoDB.

Business Case

GraphQL does offer more robust solutions regarding the dataStore API and schema based design patterns, however by increasing the documentation surrounding more traditional API’s, the barrier to entry would be lowered since REST endpoints are typically more understood than GraphQL SDL. Also, in addition to helping those using other serverless automation tools transition to Amplify, there would be a path for teams to start with a REST setup and slowly transition to a graphQL setup–perhaps with the help of the @function or @http directives.

---

Path Forward

I’m open to solutions on updating the docs, however I did want to point out, that I currently have a post that details how to bring in existing resources for use within an Amplify project that could be ported over to the docs in some fashion, in addition to a video tutorial that demonstrates how to create a REST API with dynamodb and call it on the frontend (currently no available in the docs).

So in short, a list of common REST topics would go a long way, and in addition to my own content, I’m hoping others would contribute their wants, ideas, and content as well.

[mtliendo]

Thanks for keeping this open while I took a brief pause from OSS! I’m happy to circle back in a day or so!

[mtliendo]

Closing since I think the Amplify guides serve as a good place to enhance walkthrough-style documentation.