Giter Club home page Giter Club logo

requestbin-sample's Introduction

Durable RequestBin Sample

This shows a code sample to emulate RequestBin, using Azure Durable Functions

Prerequisites

Getting Started

Clone Repository

  • Clone this repository to your local.
git clone https://github.com/devkimchi/RequestBin-Sample.git

App Settings

Update local.settings.json with the storage account connection string.

Endpoints

There are five different endpoints on this function app.

Create Bin: /bins

This creates a new bin to take all requests.

curl -X POST -H "Content-Length: 0" "http://localhost:7071/bins"

The response might look like, with the HTTP status code of 201 (Created):

{
  "bin": "http://localhost:7071/bins/<bin-id>",
  "history": "http://localhost:7071/bins/<bin-id>/history",
  "reset": "http://localhost:7071/bins/<bin-id>/reset",
  "purge": "http://localhost:7071/bins/<bin-id>/purge"
}

Add Request to Bin: /bins/<bin-id>

This sends requests to bin. VERB can be GET, POST, PUT, PATCH, DELETE, etc.

curl -X POST -H "Authorization: Basic 12345" -H "Content-Type: application/json" "http://localhost:7071/bins/<bin-id>" -d '{ "hello": "world" }'

The response might look like, with the HTTP status code of 202 (Accepted):

{
  "bin": "http://localhost:7071/bins/<bin-id>",
  "history": "http://localhost:7071/bins/<bin-id>/history",
  "reset": "http://localhost:7071/bins/<bin-id>/reset",
  "purge": "http://localhost:7071/bins/<bin-id>/purge"
}

List Requests from Bin: /bins/<bin-id>/history

This gets the request history.

curl -X GET "http://localhost:7071/bins/<bin-id>/history"

The response might look like, with the HTTP status code of 200 (OK):

{
  "history": [
    {
      "timestamp": "2020-04-19T07:36:19.082+00:00",
      "method": "POST",
      "headers": {
        // LIST OF HEADERS
      },
      "queries": {
        // LIST OF QUERIES
      },
      "body": "<REQUEST_PAYLOAD>"
    }
  ],
  "navigation": {
    "bin": "http://localhost:7071/bins/<bin-id>",
    "history": "http://localhost:7071/bins/<bin-id>/history",
    "reset": "http://localhost:7071/bins/<bin-id>/reset",
    "purge": "http://localhost:7071/bins/<bin-id>/purge"
  }
}

Reset Bin: /bins/<bin-id>/reset

This clears the request history from the bin.

curl -X DELETE "http://localhost:7071/bins/<bin-id>/reset"

The response might look like, with the HTTP status code of 202 (Accepted):

{
  "bin": "http://localhost:7071/bins/<bin-id>",
  "history": "http://localhost:7071/bins/<bin-id>/history",
  "reset": "http://localhost:7071/bins/<bin-id>/reset",
  "purge": "http://localhost:7071/bins/<bin-id>/purge"
}

Delete Bin: /bins/<bin-id>/purge

This removes the bin itself.

curl -X DELETE "http://localhost:7071/bins/<bin-id>/purge"

The response returns nothing but the HTTP status code of 204 (No content)

Contribution

Your contributions are always welcome! All your work should be done in your forked repository. Once you finish your work with corresponding tests, please send us a pull request onto our master branch for review.

License

This is released under MIT License

The MIT License (MIT)

Copyright (c) 2019 Dev Kimchi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

requestbin-sample's People

Contributors

justinyoo avatar

Stargazers

 avatar

Watchers

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