Code Monkey home page Code Monkey logo

azurefunction-base's Introduction

Azure Functions Base Structure with Clean Architecture

The Azure Function Base empowers developers to rapidly develop, deploy, and manage custom functions tailored to their specific needs. It provides a solid foundation for implementing clean architecture principles in Azure Functions.

Features

  • Azure Function APIs: Easily create CRUD operations for various entities.
  • File Upload Support: Seamlessly handle file uploads in your APIs.
  • Generic Response Handling: Standardize response structures for consistent client interaction.
  • Middleware Support: Implement middleware for pre-processing requests or post-processing responses.
  • Request and Response Logging: Log incoming requests and outgoing responses for improved debugging and monitoring.
  • Global Exception Handling: Handle exceptions gracefully at a global level for better error management.

Installation

To install and run the project locally, follow these steps:

  1. Clone the repository:

    $ git clone https://github.com/rahulkapoor007/AzureFunction-Base.git
    $ cd AzureFunction.FunctionApp
  2. Restore dependencies:

    $ dotnet restore
  3. Run the application:

    $ dotnet run

How to Test

You can test the following Azure Functions:

  • Create User: POST http://localhost:7052/api/users
  • Get Users: GET http://localhost:7052/api/users?filter=Shane
  • Get User by Id: GET http://localhost:7052/api/user?Id=2

Testing API

A Postman collection (AzureFunction.Base.postman_collection.json) is provided in the repository for convenient API testing.

Generic response structure:

{
    "Data": {
        "Success": true
    },
    "Succeeded": true,
    "MessageNumber": 5003,
    "Message": "Success!",
    "StatusCode": 200
}

Contributing

Contributions are welcome and encouraged! If you encounter any issues or have ideas for improvements, please open an issue. Pull requests are also appreciated. For more detailed guidelines on contributing, please refer to our Contribution Guide.

azurefunction-base's People

Watchers

Rahul Kapoor 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.