From 581e71fb276b070f3c66a5e1e720cd85b574bd3e Mon Sep 17 00:00:00 2001 From: hhimanshu Date: Mon, 19 Apr 2021 12:02:43 -0700 Subject: [PATCH] fix: update API documentation --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 843e22c..da0c26f 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,12 @@ This directory is an example of creating serverless APIs in TypeScript and deplo - [x] Deployment on Vercel for main branch and pull requests - [x] Tests support using `Jest` - [x] CI setup using GitHub Actions to run tests on every push to GitHub (on every branch) +- [x] CI setup to run tests against Vercel Preview URLs and add them as check before PR could merge. [See GitHub Action](https://github.com/hhimanshu/typescript-serverless-api-vercel/actions/workflows/preview-ci.yml) - [x] CI Setup to create a new release using `semantic-release` - [x] Ability to compute function (`/address`) and also to make API calls (`/currency`) ## Available APIs +### Local ```shell http://localhost:3000/api/hello?name= http://localhost:3000/api/address?total=&type= @@ -30,6 +32,13 @@ http://localhost:3000/api/address?total=10&type=city http://localhost:3000/api/currency ``` +### Production +- https://typescript-serverless-api-vercel-al75io70u-hhimanshu.vercel.app/api/hello?name=harit +- https://typescript-serverless-api-vercel-al75io70u-hhimanshu.vercel.app/api/address?total=20&type=zipCode +- https://typescript-serverless-api-vercel-al75io70u-hhimanshu.vercel.app/api/address?total=10&type=city +- https://typescript-serverless-api-vercel-al75io70u-hhimanshu.vercel.app/api/currency + + ## Start Developing - Clone this repository (or better fork it so that you can make changes in your repo) - Run `yarn start`. This will kick-off `vercel dev` so that you can start developing your features