The Hair Extensions API is a RESTful API that allows users to manage and retrieve information about hair extensions. It is built using AWS SAM on AWS, leveraging AWS Lambda, API Gateway, and DynamoDB.
- List Hair Extensions: Retrieve a list of all available hair extensions.
- Get Hair Extension: Get detailed information about a specific hair extension by ID.
- Create Hair Extension: Add a new hair extension to the database.
- Node.js (v14.x or later)
- AWS SAM CLI
- AWS CLI
- AWS Account with appropriate IAM permissions
-
Clone the repository:
git clone https://github.com/FonNkwenti/openapi-apigw-hair-extensions-api.git
-
Install the dependencies:
cd hair-extensions-api npm install
-
Set up your AWS credentials using the AWS CLI:
aws configure
-
Build the application using AWS SAM::
sam build
-
Deploy the API to your AWS account using AWS SAM:
sam deploy -g
This command will deploy the Lambda functions, API Gateway, and DynamoDB table required for the Hair Extensions API.
-
Once the deployment is successful, you will receive an API Gateway endpoint URL. You can use this URL to make requests to the Hair Extensions API.
For detailed information on how to use the Hair Extensions API, refer to the API documentation.
src/
- Contains the source code for the Lambda functions.events/
- Contains sample event payloads for local testing.__tests__/
- Contains unit tests.template.yaml
- AWS SAM template defining the infrastructure resources.hair-extension-api.yaml
- Contains OpenAPI v3 definition for the Hair Extensions API.
Contributions are welcome! If you find any issues or have suggestions for improvement, feel free to create a GitHub issue or submit a pull request.
This project is licensed under the MIT License.