Giter VIP home page Giter VIP logo

openapi-apigw-hair-extensions-api's Introduction

Hair Extensions API

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.

Features

  • 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.

Prerequisites

  • Node.js (v14.x or later)
  • AWS SAM CLI
  • AWS CLI
  • AWS Account with appropriate IAM permissions

Getting Started

  1. Clone the repository:

    git clone https://github.com/FonNkwenti/openapi-apigw-hair-extensions-api.git
  2. Install the dependencies:

    cd hair-extensions-api
    npm install
  3. Set up your AWS credentials using the AWS CLI:

    aws configure
  4. Build the application using AWS SAM::

    sam build
  5. 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.

  6. 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.

API Documentation

For detailed information on how to use the Hair Extensions API, refer to the API documentation.

Project Structure

  • 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.

Contributing

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.

License

This project is licensed under the MIT License.

openapi-apigw-hair-extensions-api's People

Contributors

fonnkwenti avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.